diff --git a/graphql.md b/graphql.md new file mode 100644 index 0000000..947685a --- /dev/null +++ b/graphql.md @@ -0,0 +1,35 @@ +Statping implements the [GraphQL](https://graphql.org/) API interface so you can customize the exact data you need within a query. The GraphQL endpoint is at `/graphql` on your Statping instance and is only available for Authenticated users or while sending the `Authorization` API Secret. + +

+View schema.graphql +

+ +*** + +### Example Queries + +Retrieve the `id`, `name`, and `public` parameters from `service` #2. +###### GraphQL Query: +```graphql +{ + service(id: 2) { + id + name + public + } +} +``` +###### Response: +```json +{ + "data": { + "service": { + "id": 2, + "name": "Statping Github", + "public": true + } + } +} +``` + +***