List all GraphQL Cost Decorations in a workspace

List all GraphQL Cost Decorations in a workspace

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A successful response listing GraphQL Cost Decorations

dataarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/{workspace}/graphql-rate-limiting-advanced/costs
 
application/json

Get a GraphQL Cost Decoration in a workspace

Get a GraphQL Cost Decoration using ID in a workspace.

get

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

GraphQLCostDecorationIdstringrequired

ID of the GraphQL Cost Decoration to lookup

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

Successfully fetched GraphQL Cost Decoration

GraphQLCostDecoration

* Additional properties are NOT allowed.
add_argumentsarray[string]

Default:[]

add_constantnumber

Default:1

created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

mul_argumentsarray[string]

Default:[]

mul_constantnumber

Default:1

serviceobject
Show Child Parameters
type_pathstringrequired
get/control-planes/{controlPlaneId}/core-entities/{workspace}/graphql-rate-limiting-advanced/costs/{GraphQLCostDecorationId}
 
application/json

List all GraphQL Cost Decorations associated with a Service in a workspace

List all GraphQL Cost Decorations associated with a Service in a workspace

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

A successful response listing GraphQL Cost Decorations

dataarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/{workspace}/services/{ServiceId}/graphql-rate-limiting-advanced/costs
 
200 application/json

Create a new GraphQL Cost Decoration associated with a Service in a workspace

Create a new GraphQL Cost Decoration associated with a Service in a workspace

post

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Description of new GraphQL Cost Decoration for creation

GraphQLCostDecorationWithoutParents

* Additional properties are NOT allowed.
add_argumentsarray[string]

Default:[]

add_constantnumber

Default:1

created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

mul_argumentsarray[string]

Default:[]

mul_constantnumber

Default:1

serviceobject
Show Child Parameters
type_pathstringrequired

Response

201 application/json

Successfully created GraphQL Cost Decoration

GraphQLCostDecoration

* Additional properties are NOT allowed.
add_argumentsarray[string]

Default:[]

add_constantnumber

Default:1

created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

mul_argumentsarray[string]

Default:[]

mul_constantnumber

Default:1

serviceobject
Show Child Parameters
type_pathstringrequired
post/control-planes/{controlPlaneId}/core-entities/{workspace}/services/{ServiceId}/graphql-rate-limiting-advanced/costs

Body

{ "type_path": "type_path" }
 
201 application/json

Delete a a GraphQL Cost Decoration associated with a Service in a workspace

Delete a a GraphQL Cost Decoration associated with a Service using ID in a workspace.

delete

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

GraphQLCostDecorationIdstringrequired

ID of the GraphQL Cost Decoration to lookup

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

204

Successfully deleted GraphQL Cost Decoration or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/{workspace}/services/{ServiceId}/graphql-rate-limiting-advanced/costs/{GraphQLCostDecorationId}
 
204