API Specs

Record that a version went into an environment

Tells Routebase which version an environment now serves. The intended order is that your pipeline deploys first and then makes this call, so the pin reflects what is actually running rather than what someone intended.

A call authenticated with an API key is recorded with source cli, which is how a pipeline assertion is told apart from someone clicking in the UI. If the target environment freezes versions, the promoted version becomes immutable here.

post/api/projects/{projectId}/specs/{specId}/versions/{versionId}/promote

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/projects/{projectId}/specs/{specId}/versions/{versionId}/promote
  • Auth: API key in header X-API-Key

Path parameters

ProjectIdstring uuid required

Public id of the project.

SpecIdstring uuid required

Public id of the API specification.

VersionIdstring uuid required

Public id of the specification version.

Headers

X-RB-Regionstring
Example:us

Region of your organization. US organizations must send us; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.

Request body

environmentIdstring uuid required

Environment the version was deployed to.

publishTarget'internal' | 'public' | 'exportOnly'

Who a published version is visible to.

impactAcknowledgedboolean nullable

Confirms you have seen the effect on dependent services. Send true to clear a promotion that was refused with 409 for that reason.

Response

The promotion was recorded.

promotionIdstring uuid required

Public id of this promotion record, which the audit trail refers to.

environmentIdstring uuid required

Public id of the environment the version went into.

environmentNamestring required

Display name of that environment.

versionIdstring uuid required

Public id of the promoted version.

versionNumberstring required

Version label of the promoted version.

frozeVersionboolean required

Whether this promotion made the version immutable.

previousVersionNumberstring nullable

What the environment pinned before, or null if this is the first promotion.

source'manual' | 'cli' | 'gatewayDeployment' required

Where a version pin came from. A call authenticated with an API key is recorded as cli, which marks it as a pipeline assertion rather than a manual entry.

isRollbackboolean required

Whether the pin moved back to a version the environment served earlier.

Changes

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