Skip to main content
POST
Revise an API

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Repeating a request with the same key returns the same build without starting or charging a second one. The same key with a different request returns 409 idempotency_key_reused.

Required string length: 1 - 255

Path Parameters

api_id
string
required

Body

application/json
instructions
string
required
wait_for_completion
boolean
default:false
timeout_ms
integer
Required range: 1000 <= x <= 300000
draft
boolean
default:false

Build a draft: the new version is stored but the current one keeps serving until you publish the draft with rollback.

Response

Revision request result.

api
object
required
revision_queued
boolean
required
waited
boolean
required
timed_out
boolean
required