ReferenceAPI overview
Request bodies
The body of a request is JSON. Two endpoints also take a different content type.
Send the body as JSON.
The rules of a body
| Subject | Rule |
|---|---|
The Content-Type header | The server does not require it. |
| An empty body | It counts as {}. |
| A field that the endpoint does not know | A 400 error. A wrong field name never passes with no effect. |
| Source upload | The content type application/gzip: a .tar.gz of 512 MiB at most. |
| Blueprint apply | It also accepts raw YAML: application/yaml. |
The error for an unknown field:
invalid JSON body: unknown field 'nope', expected one of 'name', 'type', 'repo_url', …Booleans in the query string
A boolean flag in the query string accepts these values:
| Meaning | Values |
|---|---|
| True | true, 1, yes, on, y, or the flag with no value (?follow) |
| False | false, 0, no, off, n |