List Default Resource Configurations
Returns a paginated collection of default resource configurations for cloud-gateways, along with
organizationally-defined overrides for those resource configurations.
Resource configurations are settings that are applied to all cloud gateway resources in an organization.
For example, the “data-plane-group-idle-timeout-minutes” resource configuration sets the idle timeout for all data plane groups in an organization.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated list for a collection of default resource configurations.
ListDefaultResourceConfigurationsResponse
returns the pagination information
Show Child Parameters
Object containing information about a default resource configurations, and any organizational overrides.
Show Child Parameters
Authentication
Query Parameters
List Resource Configurations
Returns a paginated collection of resource configurations for an organization.
Resource configurations are settings that are applied to all cloud gateway resources in an organization.
For example, the “data-plane-group-idle-timeout-minutes” resource configuration sets the idle timeout for all data plane groups in an organization.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated list for a collection of resource configurations.
ListResourceConfigurationsResponse
returns the pagination information
Show Child Parameters
Object containing information about a resource configuration.
Show Child Parameters
Authentication
Query Parameters
Get Resource Configuration
Retrieves a resource configuration by ID.
Path Parameters
The ID of the resource configuration to operate on.
Example:9678f205-49a1-47bb-82d9-d01cafa42a0d
Response
application/json
Response
Response format for retrieving a resource configuration for an organization.
Resource Configuration
Object containing information about a resource configuration.
Example:9678f205-49a1-47bb-82d9-d01cafa42a0d
Enumeration of configuration qualifiers available for organization-wide configuration.
Allowed values:data-plane-group-idle-timeout-minutes
The value of this resource configuration.
Example:45
Authentication
Path Parameters
Resource Availability
Get Resource Availability JSON
Get Cloud Gateways Availability JSON document for describing cloud provider and region availability, pricing,
gateway version availability, and instance type information.
Response
200 application/json
Response
Response format for retrieving the cloud gateways availability JSON document.
Availability Document
Document containing availability information for configurations.
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:3.2
Resource parameters and pricing of a given supported instance type.
Show Child Parameters
Description of cloud provider that runs cloud gateway instances.
Show Child Parameters
Description of cloud provider that runs serverless v1 cloud gateway instances.