Overview

Vamp has one REST API. For details on pagination, and request and response formats see common parameters.
For details on formatting Websockets API requests see Vamp API - websockets.

API endpoints and resource descriptions

Send multiple resources

It is possible to POST, PUT or DELETE YAML or JSON documents containing more than one artifact definition.

Similar artifacts can be sent to a specific endpoint, such as /api/v1/breeds. Different artifact types can also be sent together by using the general endpoint api/v1 and including a kind field in each artifact definition. The artifact kind corresponds to the singular form of the artifact type (for example blueprint, breed, condition).

Example (YAML) - post multiple artifacts to a specific endpoint

POST /api/v1/breeds

---
name: ...
# breed 1 definition ...
---
name: ...
# breed 2 definition ....
---
name: ...
# breed 3 definition ....

Example (YAML) - post multiple artifact types to /api/v1

When using the general api/v1 endpoint, each artifact description must include a kind field.

POST /api/v1

---
name: ...
kind: blueprint
# blueprint definition ...
---
name: ...
kind: breed
# breed definition ...
---
name: ...
kind: condition
# condition definition ...