Schema/Metadata API Reference: Remote schemas¶
Table of contents
Introduction¶
Add/Remove a remote GraphQL server as remote schema in Hasura GraphQL engine.
add_remote_schema¶
add_remote_schema is used to add a remote GraphQL server as remote schema. GraphQL engine stitches it’s schema with existing.
An example request as follows:
POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin
{
"type": "add_remote_schema",
"args": {
"name": "my remote schema",
"definition": {
"url": "https://remote-server.com/graphql",
"headers": [{"name": "X-Server-Request-From", "value": "Hasura"}],
"forward_client_headers": false,
"timeout_seconds": 60
},
"comment": "some optional comment"
}
}
| Key | Required | Schema | Description |
|---|---|---|---|
| name | true | RemoteSchemaName | Name of the remote schema |
| definition | true | RemoteSchemaDef | Definition for the remote schema |
| comment | false | Text | comment |
remove_remote_schema¶
remove_remote_schema is used to delete a remote schema. GraphQL engine de-stitches it’s schema.
An example request as follows:
POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin
{
"type": "remove_remote_schema",
"args": {
"name": "my remote schema"
}
}
| Key | Required | Schema | Description |
|---|---|---|---|
| name | true | RemoteSchemaName | Name of the remote schema |
reload_remote_schema¶
reload_remote_schema is used to refresh schema of the remote server. GraphQL engine refetches schema from server and stitches.
An example request as follows:
POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin
{
"type": "reload_remote_schema",
"args": {
"name": "my remote schema"
}
}
| Key | Required | Schema | Description |
|---|---|---|---|
| name | true | RemoteSchemaName | Name of the remote schema |
Was this page helpful?
Thank you for your feedback!
Stay up to date with product & security news
Thank you for subscribing to our newsletter!
