9721844b05
* docs(nxdev): consume nx cloud documentation & dedicated menu * docs(nxdev): nx-cloud docs visually indicated nx-cloud docs in nx.dev * docs(nxdev): formatting visually indicated nx-cloud docs in nx.dev * docs(nxdev): fix config * docs(nxdev): fix header link * docs(nxdev): consolidate dte set up guides Co-authored-by: ben <3447705+bcabanes@users.noreply.github.com>
22 lines
710 B
Markdown
22 lines
710 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://api.nrwl.io/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/), and paste in the url to the Nx API definitions (https://api.nrwl.io/api/definition.json).
|
|
|
|
|