OrkStageOrkStage
API referenceInstances

POST /instances/{id}/domains

POST /instances/{id}/domains: OrkStage Control API v1 endpoint reference.

POST
/api/v1/instances/{id}/domains

Authorization

headerAuthorizationBearer <ork_<env>_<id>_<secret>>

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

id*string

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
hostname*string
Match^(?=.{4,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
Lengthlength <= 253
resourceId?string
Length1 <= length <= 63

Response Body

Example Request
curl -X POST 'http://localhost:4000/api/v1/instances/string/domains' \  -H 'Content-Type: application/json' \  -d '{  "hostname": "string"}'
Example Response201
Empty
Edit on GitHub

GET /instances/{id}/domains GET

GET /instances/{id}/domains: OrkStage Control API v1 endpoint reference.

POST /domains/{id}/verify POST

POST /domains/{id}/verify: OrkStage Control API v1 endpoint reference.