22 lines
834 B
Markdown
22 lines
834 B
Markdown
# Nx Cloud Server API Reference
|
|
|
|
## OpenAPI
|
|
|
|
The nx-api has an OpenAPI `3.0.3` spec definition available at:
|
|
|
|
[https://cloud.nx.app/nx-cloud/api/definition.json](https://cloud.nx.app/nx-cloud/api/definition.json)
|
|
|
|
## Authenticating
|
|
|
|
To authenticate, you may use your tokens (accessible from Nx Cloud):
|
|
|
|
|
|
|
|
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/?url=https://cloud.nx.app/nx-cloud/api/definition.json), and paste in the url to the Nx API definitions (https://cloud.nx.app/nx-cloud/api/definition.json).
|
|
|
|
|