FerryDocs
ReferenceAPI overview

Ids and names in paths

Where a path has {id}, a service, a datastore or an env group accepts its id or its name.

Edit on GitHub
Two paths, the same service
/api/v1/services/api
/api/v1/services/srv-60f5973b037e4478ae7b

A is a prefix and 20 . The prefixes are srv, dep, job, dbs and evg.

What a path accepts

ResourcePrefixExample of an idIn a path
Servicesrvsrv-60f5973b037e4478ae7bThe id or the name
DatastoredbsThe id or the name
Env groupevgevg-c15c37b6f91044ff920bThe id or the name
Deploydepdep-3271cdfd1415400d9a5eThe id only
Job runjobThe id only
Deploy hookThe id of the service only

A name cannot look like an id

Ferry refuses a name that looks like an id. Thus Ferry always knows if a path has an id or a name.

On this page