Propose opaque route authority without creating an active delivery route.

Authorization

platformSession

laravel_session<token>

In: cookie

Header Parameters

X-XSRF-TOKEN*string

CSRF token paired with the current web session.

Length1 <= length <= 2048

Idempotency-Key*string

Match^[A-Za-z0-9][A-Za-z0-9._:-]*$

Length16 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

channel*string

Value in

"pagerduty"
"email_group"
"webhook"

destination_ref*Uuid

Formatuuid

minimum_severity*string

Value in

"degraded"
"critical"

effective_at*IsoDateTime

Formatdate-time

expires_at?|null

Response Body

`application/json`

curl -X POST "https://example.com/platform/v1/payout-alert-route-proposals" \  -H "X-XSRF-TOKEN: string" \  -H "Idempotency-Key: stringstringstri" \  -H "Content-Type: application/json" \  -d '{    "channel": "pagerduty",    "destination_ref": "0916de6d-6561-4b55-85e1-d369309d4c11",    "minimum_severity": "degraded",    "effective_at": "2019-08-24T14:15:22Z"  }'

{  "data": {    "proposal": {      "ref": "d0fad5d6-e996-4437-8fb9-5f40bbcfd7cc",      "status": "pending",      "channel": "pagerduty",      "destination_ref": "0916de6d-6561-4b55-85e1-d369309d4c11",      "minimum_severity": "degraded",      "effective_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "proposed_by": "4950251e-cd25-4a79-b482-8e67fe2adc20",      "proposed_at": "2019-08-24T14:15:22Z",      "decided_by": "4accc021-c0cc-4c2c-8a78-605a0ed6da31",      "decided_at": "2019-08-24T14:15:22Z",      "decision_reason": "stringst"    },    "replayed": true  }}

Authorization

Header Parameters

Request Body

Response Body

201application/json

401application/json

403application/json

409application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`