Upsert a GraphQL Cost Decoration associated with a Service

Create or Update a GraphQL Cost Decoration associated with a Service using ID.

put

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

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

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

Body

application/json

Description of the GraphQL Cost Decoration

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

200 application/json

Successfully upserted 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
put/control-planes/{controlPlaneId}/core-entities/services/{ServiceId}/graphql-rate-limiting-advanced/costs/{GraphQLCostDecorationId}

Body

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

HMAC-auth credentials

List all HMAC-auth credentials associated with a Consumer

List all HMAC-auth credentials associated with a Consumer

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

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

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 HMAC-auth credentials

dataarray[object]

Example:{"consumer":{"id":"84a73fb8-50fc-44a7-a4d5-aa17728ee83f"},"id":"75695322-e8a0-4109-aed4-5416b0308d85","secret":"wQazJ304DW5huJklHgUfjfiSyCyTAEDZ","username":"xerxes"}

* 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/consumers/{ConsumerIdForNestedEntities}/hmac-auth
 
200 application/json

Create a new HMAC-auth credential associated with a Consumer

Create a new HMAC-auth credential associated with a Consumer

post

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

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 HMAC-auth credential for creation

HMACAuthWithoutParents

* Additional properties are NOT allowed.
consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

secretstring
tagsarray[string]

A string representing a tag.

usernamestringrequired

Response

201 application/json

Successfully created HMAC-auth credential

HMACAuth

* Additional properties are NOT allowed.
consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

secretstring
tagsarray[string]

A string representing a tag.

usernamestringrequired
post/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth

Body

{ "id": "75695322-e8a0-4109-aed4-5416b0308d85", "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ", "username": "xerxes" }
 
201 application/json

Delete a a HMAC-auth credential associated with a Consumer

Delete a a HMAC-auth credential associated with a Consumer using ID.

delete

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

HMACAuthIdstringrequired

ID of the HMAC-auth credential to lookup

Example:70e7b00b-72f2-471b-a5ce-9c4171775360

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 HMAC-auth credential or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}
 
204