Cloud Service Provider Controller Resource

The API allows you to list, view, create and edit cloud service provider.

GET /cloud-service-providers

Returns list of cloud service providers list records filtered by specified query parameters.

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of CloudServiceProviderListRecord (JSON) list of cloud service providers list records filtered by specified query parameters

Example

Request
GET /cloud-service-providers
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "cloudServiceProviderType" : "MICROSOFT365",
  "name" : "...",
  "possibleActions" : [ "INVENTORY_SYNC", "HVM_READ" ]
} ]
                
              

POST /cloud-service-providers

Create a service provider.

Request Body
media type data type description
application/json CloudServiceProviderRequest (JSON) specify data for new provider
Response Body
media type data type description
application/json CloudServiceProviderDetails (JSON) details of newly created provider

Example

Request
POST /cloud-service-providers
Content-Type: application/json
Accept: application/json

                
{
  "cloudServiceProviderType" : "MICROSOFT365",
  "name" : "...",
  "tenantId" : "...",
  "applications" : [ {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  }, {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  } ],
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "filterUser" : {
    "usageLocation" : [ "...", "..." ],
    "country" : [ "...", "..." ],
    "officeLocation" : [ "...", "..." ]
  }
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "cloudServiceProviderType" : "MICROSOFT365",
  "name" : "...",
  "tenantId" : "...",
  "applications" : [ {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  }, {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  } ],
  "possibleActions" : [ "HV_READ", "READ" ],
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "filterUser" : {
    "usageLocation" : [ "...", "..." ],
    "country" : [ "...", "..." ],
    "officeLocation" : [ "...", "..." ]
  }
}
                
              

GET /cloud-service-providers/rbac-contexts

Returns list of cloud service providers for a rbac context

Response Body
media type data type description
application/json array of RbacContextListRecord (JSON) list of cloud service provider rbac context wrappers

Example

Request
GET /cloud-service-providers/rbac-contexts
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "type" : "HYPERVISOR_MANAGER",
  "checked" : true,
  "lastLevel" : true,
  "present" : true,
  "entityType" : "...",
  "childrenQueryType" : "..."
} ]
                
              

DELETE /cloud-service-providers/{guid}

Remove service provider.

Request Parameters
name type description
guid path specify local unique identifier for provider (use by vProtect)

Example

Request
DELETE /cloud-service-providers/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /cloud-service-providers/{guid}

Get a single service provider.

Request Parameters
name type description
guid path specify local unique identifier for service provider (use by vProtect)
Response Body
media type data type description
application/json CloudServiceProviderDetails (JSON) service provider details

Example

Request
GET /cloud-service-providers/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "cloudServiceProviderType" : "MICROSOFT365",
  "name" : "...",
  "tenantId" : "...",
  "applications" : [ {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  }, {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  } ],
  "possibleActions" : [ "HV_READ", "HV_READ" ],
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "filterUser" : {
    "usageLocation" : [ "...", "..." ],
    "country" : [ "...", "..." ],
    "officeLocation" : [ "...", "..." ]
  }
}
                
              

PUT /cloud-service-providers/{guid}

Change provider details.

Request Parameters
name type description
guid path specify local unique identifier for provider (use by vProtect)
Request Body
media type data type description
application/json CloudServiceProviderRequest (JSON) specify provider details to update
Response Body
media type data type description
application/json CloudServiceProviderDetails (JSON) updated details of provider

Example

Request
PUT /cloud-service-providers/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "cloudServiceProviderType" : "MICROSOFT365",
  "name" : "...",
  "tenantId" : "...",
  "applications" : [ {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  }, {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  } ],
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "filterUser" : {
    "usageLocation" : [ "...", "..." ],
    "country" : [ "...", "..." ],
    "officeLocation" : [ "...", "..." ]
  }
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "...",
  "cloudServiceProviderType" : "MICROSOFT365",
  "name" : "...",
  "tenantId" : "...",
  "applications" : [ {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  }, {
    "guid" : "...",
    "clientId" : "...",
    "clientSecret" : "...",
    "secretChanged" : true
  } ],
  "possibleActions" : [ "READ", "WRITE" ],
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "filterUser" : {
    "usageLocation" : [ "...", "..." ],
    "country" : [ "...", "..." ],
    "officeLocation" : [ "...", "..." ]
  }
}