Move a project to a chosen address

Starts a durable operation that re-publishes the project's Dev and Prod gateways at the chosen address and stores it only once both serve it. The previous address stops answering and returns to the pool for any project to claim. Ask GET /v1/project-handles/{handle} first; a taken, unusable or unchanged address is refused before any gateway moves, and a project with an operation in flight is refused until it finishes.

put/v1/projects/{project_id}/handle

Request

  • Base URL: https://app.ohmyho.st
  • URL: https://app.ohmyho.st/v1/projects/{project_id}/handle
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project identifier.

Headers

X-Request-Idstring

Optional caller-provided correlation identifier.

Idempotency-Keystring required

Identifies one mutation and its canonical request payload.

If-Matchstring required

Use resource_etag from a fresh rollback, promotion, deletion or data-change plan. For a project address change, use etag from project status; an ETag from another representation is not accepted.

Request body

handlestring required

One to five lowercase words of letters and digits.

Response

The mutation was accepted for asynchronous processing.

blocking_operation_idstring
deployment_idstring
idstring required
state'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
created_atstring date-time required
updated_atstring date-time required
resultobject

Changes

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