API referencestatus
POST /maintenance-windows
POST /maintenance-windows: OrkStage Control API v1 endpoint reference.
POST
header
AuthorizationBearer <ork_<env>_<id>_<secret>>Organization API key (scoped). Sessions use the cookie instead.
x-orkstage-csrf?unknownCookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.
application/json- body
tenantId*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidinstanceId?|nulltitle*stringLength
3 <= length <= 120message?|nullcomponentNames?array<>Items
items <= 20Default
[]startsAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Format
date-timeendsAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Format
date-timecurl -X POST 'http://localhost:4000/api/v1/maintenance-windows' \ -H 'Content-Type: application/json' \ -d '{ "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0", "title": "string", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z"}'Example Response201
Empty