Skip to main content

REST API placeholders

Endpoints throughout the REST API documentation are written with placeholders in braces rather than real values — /api/v1/read/{identifier}?{auth}, for example. Each placeholder stands for a value you supply, and each one has its own rules.

The placeholders

  • {auth} — how you authenticate the request, either as URL parameters or in the message body.
  • {identifier} — which asset the operation acts on, given either as a path or as an id.
  • {wsdl} — the structure the operation's message body has to conform to.

See Operations for the full endpoint list, and REST API for how the API compares to SOAP Web Services.