Skip to main content
POST
/
products
/
{product_id}
/
api-details
/
{api_id}
/
graphql
/
schema
Upload GraphQL schema file of an API
curl --request POST \
  --url http://localhost:3001/portal-api/products/{product_id}/api-details/{api_id}/graphql/schema \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
"invalid file format, multiple files uploaded, or validation failed"

Authorizations

​
Authorization
string
header
required

Path Parameters

​
product_id
integer
required

UID of an API Product

​
api_id
string
required

UID of an API as it comes from the API Provider

Example:

"a0ce49d559ce49d64fe608ea3728082a"

Query Parameters

​
dry_run
boolean
default:false

If true, only validates the file without saving it

Body

multipart/form-data
​
file
file

GraphQL schema file (.graphql, .gql, or .json) - only 1 file at a time

Response

OK