Update an endpoint
PATCH
/v1/endpoints/{id}
Update editable fields. A url MOVES the endpoint to that URL — its identity — under the same rules as createEndpoint; a URL another live endpoint owns returns 409. The endpoint's edge config moves with it (the old URL stops serving it).
Authorizations
apiKey
Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Request Body
application/json
JSON "url": "https://wh.emhk.in/acme/shopify-store/orders", "name": "Shopify orders", "preset": "shopify", "status": "paused", "destinations": [ "string" ], "responseRules": { "rules": [ { "when": { "type": "string", "name": "string", "path": "string", "op": "string", "value": "string", "all": [ { } ], "any": [ { } ], "not": "[Circular Reference]" }, "respond": { "status": 201, "body": "{"pong":true}", "headers": { "additionalProperties": "string" } } } ], "default": { "status": 201, "body": "{"pong":true}", "headers": { "additionalProperties": "string" } } }, "responseProxy": { "target": "managed", "code": "string", "url": "string", "timeoutMs": 0, "onUnavailable": "string" }, "transform": { "engine": "managed", "code": "string", "url": "string", "failMode": "string", "timeoutMs": 0 }, "response": { "type": "meta-challenge", "verifyToken": "string", "secret": "string", "verificationToken": "string", "endpointUrl": "string", "status": 0, "body": "string", "headers": { "additionalProperties": "string" } }
{
}
Responses
The updated endpoint.
application/json
JSON "id": "ep_01JX9", "path": "/acme/shopify-store/orders", "name": "Shopify orders", "preset": "shopify", "url": "https://wh.emhk.in/acme/shopify-store/orders", "domain": { "id": "pdom_wh_emhk_in", "host": "wh.emhk.in", "kind": "platform" }, "destinations": [ "string" ], "responseRules": { "rules": [ { "when": { "type": "string", "name": "string", "path": "string", "op": "string", "value": "string", "all": [ { } ], "any": [ { } ], "not": "[Circular Reference]" }, "respond": { "status": 201, "body": "{"pong":true}", "headers": { "additionalProperties": "string" } } } ], "default": { "status": 201, "body": "{"pong":true}", "headers": { "additionalProperties": "string" } } }, "responseProxy": { "target": "managed", "code": "string", "url": "string", "timeoutMs": 0, "onUnavailable": "string" }, "transform": { "engine": "managed", "code": "string", "url": "string", "failMode": "string", "timeoutMs": 0 }, "response": { "type": "meta-challenge", "verifyToken": "string", "secret": "string", "verificationToken": "string", "endpointUrl": "string", "status": 0, "body": "string", "headers": { "additionalProperties": "string" } }, "verification": "hmac-sha256", "status": "active"
{
}