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

    This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.

  • 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

  • 200

    Success

    Hide response attributes Show response attributes object

    Helper class to be used on paged collection entities

    • items array[object] | null

      The items for this page.

      Hide items attributes Show items attributes object

      View model that represents a provider's instance.

    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Hide paginationParameters attributes Show paginationParameters attributes object
    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object

    Helper class to be used on paged collection entities

    • items array[object] | null

      The items for this page.

      Hide items attributes Show items attributes object

      View model that represents a provider's instance.

    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Hide paginationParameters attributes Show paginationParameters attributes object
    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object

    Helper class to be used on paged collection entities

    • items array[object] | null

      The items for this page.

      Hide items attributes Show items attributes object

      View model that represents a provider's instance.

    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Hide paginationParameters attributes Show paginationParameters attributes object
    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.

    • Additional properties are NOT allowed
  • 400

    Bad Request

    Hide response attributes Show response attributes object

    This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.

    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object

    This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.

    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object

    This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.

    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    • Additional properties are NOT allowed
  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Server Error

    Hide response attributes Show response attributes object

    This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.

    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object

    This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.

    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object

    This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.

    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

    • Additional properties are NOT allowed
GET /v1/Providers/Instances 
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Providers/Instances \
 -H "X-Tenant: string" \
 -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"
      ]
    }
  ]
}