Sign in
providers

Get the identified provider resource collection

DO NOT USE THIS TO ACTUALLY MAKE AN API CALL. The 'Try it out!' button will generate a '405 Method Not Allowed' error. This is to document the response received when a request to fetch a provider resource is made. Additionally, the '{resource}' is a hierarchical specification of nested resources and resource IDs. Some examples are: 'firewalls/{id}', 'regions/{id}/security-groups/{id}' etc. The list of supported resources and their hierarchy varies from one provider to another. These resources are returned in the 'links' attribute for providers and can be seen by fetching a provider. These resources generally refer to a cloud provider resource and can be viewed in the cloud provider account directly.

get/providers/{id}/{resource}/{id}

Response

The call was successful.

idstring

Unique identifier to identify the resource in the cloud provider account. In certain cases, the resource name may be the same as its ID.

namestring

Name given to this resource in the cloud provider account.

descriptionstring

Description of the resource as specified in the cloud provider account.

summarystring

A summary description of the resource, constructed by the system automatically, to highlight the essential properties of the resource.

restricted_toobject

Defines the restrictions that is placed upon this resource in relation to other provider resources. For example, a subnet resource will specify the network href that it is restricted to be used with and/or a zone href where it is limited to be used within.

Changes