release

Get a release's custom metadata

Returns the custom metadata attached to the release, keyed by a stable id derived from each entry's title. Returns an empty object if none is set.

get/app/{appId}/release/{releaseId}/metadata

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/release/{releaseId}/metadata
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

releaseIdstring required

The id of the release. Constructed from the app's id and the release version like so: {appId}:{version}. For the GET single release endpoint, the following keywords are also accepted: live (latest completed release), next or current (current active release).

Response

The release's custom metadata

CustomMetadata required

Custom metadata attached to the release, keyed by a stable id derived from each entry's title. Each value is an entry with a human-readable title and a value that may be any JSON type.

Example response

{
  "incident-4821": {
    "title": "Incident link",
    "value": "https://incidents.example.com/4821"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.