FerryDocs
ReferenceAPI overview

Request bodies

The body of a request is JSON. Two endpoints also take a different content type.

Edit on GitHub
JSONthe default.tar.gzapplication/gzipYAMLapplication/yamlEach endpointSource uploadBlueprint apply
The content type of a request body

Send the as .

The rules of a body

SubjectRule
The Content-Type headerThe server does not require it.
An empty bodyIt counts as {}.
A field that the endpoint does not knowA 400 error. A wrong field name never passes with no effect.
Source uploadThe application/gzip: a .tar.gz of 512 MiB at most.
Blueprint applyIt 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 flag in the accepts these values:

MeaningValues
Truetrue, 1, yes, on, y, or the flag with no value (?follow)
Falsefalse, 0, no, off, n

On this page