Skip to content
TestLookupTestLookup
Search Ctrl K

Search TestLookup

Enter a term to search the local static index.

    Update Policy — PATCH /api/v1/release-gate-policies/{policy_id}

    Update Policy

    Update a draft policy (ADMIN only). Fails if already published.

    Endpoint: PATCH /api/v1/release-gate-policies/{policy_id}

    Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.

    • Your role must be Admin or higher.
    NameInRequiredTypeDefaultDescription
    policy_idpathyesstring (uuid)
    X-API-Keyheadernostring or nullAPI key, as an alternative to the access token (see Authentication).
    Content typeBodyRequired
    application/jsonReleaseGatePolicyUpdateyes
    StatusMeaningBody
    200Successful ResponseReleaseGatePolicyResponse (application/json)
    422Validation ErrorHTTPValidationError (application/json)

    Errors this endpoint returns, read from its source code:

    • 404, with the message “Policy not found”
    • 409, with the message “Cannot edit a published policy. Create a new version instead”

    It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.