Api Domain API

List all domain registrations in the environment

Path	Method	Protected
`/v1/envs/{environment_id}/domain-registrations`	GET	Yes

Example Response JSON


{
  "values": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "domain": "string"
    }
  ]
}

Create a new domain registration in the environment

Path	Method	Protected
`/v1/envs/{environment_id}/domain-registrations`	POST	Yes

Example Request JSON


{
  "domain": "string"
}

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "domain": "string"
}

Get domain registration by id

Path	Method	Protected
`/v1/domain-registrations/{domain_registration_id}`	GET	Yes

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "domain": "string"
}

Delete domain registration

Path	Method	Protected
`/v1/domain-registrations/{domain_registration_id}`	DELETE	Yes

Api Domain API Errors

Status Code	Description	Body
400	Invalid request, returning with a list of issues detected in the request	`{"code":"string","errors":["string"]}`
401	Unauthorized request	`{"code":"string","error":"string"}`
403	Forbidden Request	`{"code":"string","error":"string"}`
404	Entity not found	`{"code":"string","error":"string"}`
409		`{"code":"string","error":"string"}`
422	Limits of the plan exceeded	`{"code":"string","error":"string"}`
500	Internal server error	`{"code":"string","error":"string"}`