GET
/v1/apis/{apiId}/schema#format
http://appsync.{region}.amazonaws.com/v1/apis/{apiId}/schema#formatRetrieves the introspection schema for a GraphQL API.
Access Token Required: API Key
Path Parameters
apiIdstringrequired
The API ID.
Query Params
formatstringrequired
The schema format: SDL or JSON.
Allowed:
includeDirectivesboolean
A flag that specifies whether the schema introspection should contain directives.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request GET \2 --url 'http://appsync.{region}.amazonaws.com/v1/apis/{apiId}/schema#format' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}