nx/docs/nx-cloud/reference/server-api.md
Altan Stalker e4c4fe0975
fix(nx-cloud): update nx-cloud openapi reference link (#12762)
Co-authored-by: Altan Stalker <ci@nrwl.io>
2022-10-21 16:22:27 -07:00

22 lines
730 B
Markdown

# Nx Cloud Server API Reference
## OpenAPI 3.0.3
The nx-api has an OpenAPI 3.0.3 spec definition available at:
https://cloud.nx.app/nx-cloud/api/definition.json
## Authenticating
To authenticate, you may use your tokens (accessible from Nx Cloud):
![Access tokens](/nx-cloud/reference/access-tokens.png)
Per the spec, you use this token in the `Authentication` header.
## Swagger
You may use swagger to preview the spec and make requests. We do not serve our own swagger instance publicly, but you may use [the example swagger ui](https://petstore.swagger.io/), and paste in the url to the Nx API definitions (https://cloud.nx.app/nx-cloud/api/definition.json).
![Access tokens](/nx-cloud/reference/swagger-preview.png)