Common Uses

Authentication

The GraphQL API requires authentication for most queries and mutations. The developer must supply a remote.it authentication token in the token request header. There are a few ways to get the token, here is one of them:

curl -X POST https://api.remot3.it/apv/v27/user/login \
-H 'Content-Type: application/json' \
-H 'developerKey: ######################################' \
-d '{"username": "######@remote.it", "password": "######"}'

Result


...
"token": "######################################",
...

Alternatively, GraphQL also supports a JWT (web token) supplied via the Authorization header. This token will identify the caller and restrict access accordingly.

The remote.it token can be obtained using the REST API /user/login endpoint. The JWT (web token) is obtained using the remote.it OAuth provider.

 

Query

GraphQL queries are provided in the body of the POST request to the GraphQL endpoint. The query syntax is documented at https://graphql.org.

 

Schema Reference

You can view our self-documenting schema reference here.

 

Comprehensive Schema Definitions

Get more information about our schema here:

Schema Definitions

 

Examples

See some of the most common uses for our API:

Examples

Was this article helpful?
0 out of 0 found this helpful