Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451205197.1 KB

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

post/v1/apis/{apiId}/schemacreation

Path parameters

apiIdstring required

The API ID.

Request body

definitionstring required

The schema definition, in GraphQL schema language format.

Response

Success

status'PROCESSING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'SUCCESS' | 'NOT_APPLICABLE'

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.