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
Create Resource Configuration
Creates a new resource configuration for an organization.
Body
application/json
Body
CreateResourceConfigurationRequest
Request schema for creating a resource configuration for an organization.
Enumeration of configuration qualifiers available for organization-wide configuration.
Allowed values:data-plane-group-idle-timeout-minutesauto-pilot-base-rps-max-value
The value of this resource configuration.
Example:45
Response
application/json
Response
Response format for creating 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-minutesauto-pilot-base-rps-max-value
The value of this resource configuration.
Example:45
Authentication
Body
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-minutesauto-pilot-base-rps-max-value
The value of this resource configuration.
Example:45
Authentication
Path Parameters
Update Resource Configuration
Updates a resource configuration by ID.
Path Parameters
The ID of the resource configuration to operate on.
Example:9678f205-49a1-47bb-82d9-d01cafa42a0d
Body
application/json
Body
PatchResourceConfigurationRequest
Request schema for patching a resource configuration for an organization.
Enumeration of configuration qualifiers available for organization-wide configuration.
Allowed values:data-plane-group-idle-timeout-minutesauto-pilot-base-rps-max-value
The value of this resource configuration.
Example:45
Response
application/json
Response
Response format for patching 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-minutesauto-pilot-base-rps-max-value
The value of this resource configuration.
Example:45
Authentication
Path Parameters
Body
NetworkId
stringThe network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.