List all Degraphql_routes associated with a Service

List all Degraphql_routes associated with a Service

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

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 Degraphql_routes

dataarray[object]

Example:{"id":"56c4566c-14cc-4132-9011-4139fcbbe50a","query":"query{ user { email } }","service":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"},"uri":"/users"}

* 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/services/{ServiceId}/degraphql/routes
 
200 application/json

Create a new Degraphql_route associated with a Service

Create a new Degraphql_route associated with a Service

post

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

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

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 Degraphql_route for creation

Degraphql_routeWithoutParents

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

Default:GET

querystringrequired
serviceobject
Show Child Parameters
updated_atinteger

Unix epoch when the resource was last updated.

uristringrequired

Response

201 application/json

Successfully created Degraphql_route

Degraphql_route

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

Default:GET

querystringrequired
serviceobjectrequired
Show Child Parameters
updated_atinteger

Unix epoch when the resource was last updated.

uristringrequired
post/control-planes/{controlPlaneId}/core-entities/services/{ServiceId}/degraphql/routes

Body

{ "id": "56c4566c-14cc-4132-9011-4139fcbbe50a", "query": "query{ user { email } }", "uri": "/users" }
 
201 application/json

Get a Degraphql_route associated with a Service

Get a Degraphql_route associated with a Service using ID or name.

get

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

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

Degraphql_routeIdstringrequired

ID of the Degraphql_route 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 Degraphql_route

Degraphql_route

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

Default:GET

querystringrequired
serviceobjectrequired
Show Child Parameters
updated_atinteger

Unix epoch when the resource was last updated.

uristringrequired
get/control-planes/{controlPlaneId}/core-entities/services/{ServiceId}/degraphql/routes/{Degraphql_routeId}
 
application/json

Upsert a Degraphql_route associated with a Service

Create or Update a Degraphql_route associated with a Service using ID or name.

put

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

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

Degraphql_routeIdstringrequired

ID of the Degraphql_route 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 Degraphql_route

Degraphql_routeWithoutParents

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

Default:GET

querystringrequired
serviceobject
Show Child Parameters
updated_atinteger

Unix epoch when the resource was last updated.

uristringrequired

Response

200 application/json

Successfully upserted Degraphql_route

Degraphql_route

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

Default:GET

querystringrequired
serviceobjectrequired
Show Child Parameters
updated_atinteger

Unix epoch when the resource was last updated.

uristringrequired
put/control-planes/{controlPlaneId}/core-entities/services/{ServiceId}/degraphql/routes/{Degraphql_routeId}

Body

{ "id": "56c4566c-14cc-4132-9011-4139fcbbe50a", "query": "query{ user { email } }", "uri": "/users" }
 
200 application/json

GraphQL Cost Decorations