List all Provider Instances

GET /v1/Providers/Instances

Returns a list of the provider instances in the tenant. The provider instances are returned sorted by provider.

Headers

  • X-Tenant string Required

    The domain used to access the portal.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Query parameters

  • pageNumber integer(int32)

    A cursor for pagination across multiple pages of results. The default value is 1.

  • pageSize integer(int32)

    The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.

Responses

GET /v1/Providers/Instances
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Providers/Instances \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200)
{
  "items": [
    {
      "id": "string",
      "alias": "string",
      "instanceProviderId": "string",
      "imageUrl": "string",
      "offerTypes": [
        {
          "name": "string"
        }
      ],
      "supportedCountries": [
        "string"
      ],
      "providerData": "string",
      "provider": {
        "id": "string",
        "name": "string",
        "description": "string",
        "imageUrl": "string"
      }
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}
Response examples (200)
{
  "items": [
    {
      "id": "string",
      "alias": "string",
      "instanceProviderId": "string",
      "imageUrl": "string",
      "offerTypes": [
        {
          "name": "string"
        }
      ],
      "supportedCountries": [
        "string"
      ],
      "providerData": "string",
      "provider": {
        "id": "string",
        "name": "string",
        "description": "string",
        "imageUrl": "string"
      }
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}