oCoreoCore Docs
API Reference

Domains

List instance domains

Returns all custom domains configured for an instance.

GET
/instances/{id}/domains

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID

curl -X GET "//api.ocore.dev/api/instances/<string>/domains" \
  -H "Authorization: <token>"

OK

{
  "domains": [
    {
      "createdAt": "string",
      "dnsStatus": "string",
      "domain": "string",
      "id": "string",
      "instanceId": "string",
      "isAutoGenerated": true,
      "isPrimary": true,
      "sslExpiresAt": "string",
      "sslStatus": "string",
      "updatedAt": "string"
    }
  ],
  "total": 0
}

Add custom domain

Adds a custom domain to an instance and enqueues proxy configuration.

POST
/instances/{id}/domains

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Domain request

domainstring
isPrimaryboolean

Path Parameters

idRequiredstring

Instance ID

curl -X POST "//api.ocore.dev/api/instances/<string>/domains" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "isPrimary": true
  }'

Created

{
  "createdAt": "string",
  "dnsStatus": "string",
  "domain": "string",
  "id": "string",
  "instanceId": "string",
  "isAutoGenerated": true,
  "isPrimary": true,
  "sslExpiresAt": "string",
  "sslStatus": "string",
  "updatedAt": "string"
}

Get domain details

Returns details for a single domain by ID.

GET
/instances/{id}/domains/{domainId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID

domainIdRequiredstring

Domain ID

curl -X GET "//api.ocore.dev/api/instances/<string>/domains/<string>" \
  -H "Authorization: <token>"

OK

{
  "createdAt": "string",
  "dnsStatus": "string",
  "domain": "string",
  "id": "string",
  "instanceId": "string",
  "isAutoGenerated": true,
  "isPrimary": true,
  "sslExpiresAt": "string",
  "sslStatus": "string",
  "updatedAt": "string"
}

Delete custom domain

Removes a custom domain from an instance and updates proxy configuration.

DELETE
/instances/{id}/domains/{domainId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID

domainIdRequiredstring

Domain ID

curl -X DELETE "//api.ocore.dev/api/instances/<string>/domains/<string>" \
  -H "Authorization: <token>"

No Content

Update domain

Updates mutable fields on a domain (e.g. isPrimary).

PUT
/instances/{id}/domains/{domainId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Domain update

isPrimaryboolean

Path Parameters

idRequiredstring

Instance ID

domainIdRequiredstring

Domain ID

curl -X PUT "//api.ocore.dev/api/instances/<string>/domains/<string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "isPrimary": true
  }'

OK

{
  "createdAt": "string",
  "dnsStatus": "string",
  "domain": "string",
  "id": "string",
  "instanceId": "string",
  "isAutoGenerated": true,
  "isPrimary": true,
  "sslExpiresAt": "string",
  "sslStatus": "string",
  "updatedAt": "string"
}

Set primary domain

Sets a domain as the primary domain for an instance.

PUT
/instances/{id}/domains/{domainId}/primary

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID

domainIdRequiredstring

Domain ID

curl -X PUT "//api.ocore.dev/api/instances/<string>/domains/<string>/primary" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Routing adoption status

Whether the instance's proxy configuration can be adopted, and the most recent plans and adoptions. Requires manage permission on instances: plans carry the server's vhost diff.

GET
/instances/{id}/routing/adoption

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID

curl -X GET "//api.ocore.dev/api/instances/<string>/routing/adoption" \
  -H "Authorization: <token>"

OK

{
  "history": [
    {
      "changes": true,
      "confirmedSha256": "string",
      "currentSha256": "string",
      "desiredSha256": "string",
      "diff": "string",
      "diffTruncated": true,
      "droppedNames": [
        "string"
      ],
      "error": "string",
      "errorCode": "string",
      "id": "string",
      "planOnly": true,
      "preservedNames": [
        "string"
      ],
      "reason": "string",
      "recordedAt": "string",
      "requestedBy": "string",
      "status": "string",
      "succeeded": true
    }
  ],
  "latest": {
    "changes": true,
    "confirmedSha256": "string",
    "currentSha256": "string",
    "desiredSha256": "string",
    "diff": "string",
    "diffTruncated": true,
    "droppedNames": [
      "string"
    ],
    "error": "string",
    "errorCode": "string",
    "id": "string",
    "planOnly": true,
    "preservedNames": [
      "string"
    ],
    "reason": "string",
    "recordedAt": "string",
    "requestedBy": "string",
    "status": "string",
    "succeeded": true
  },
  "proxyType": "string",
  "supported": true
}

Plan or adopt an instance's routing

Queues a plan (nothing is written) or an adoption. Adoption of a vhost that differs from oCore's render requires confirmSha256 from a reviewed plan.

POST
/instances/{id}/routing/adoption

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Plan or adoption request

confirmDesiredSha256string
confirmSha256string
planOnlyboolean

Path Parameters

idRequiredstring

Instance ID

curl -X POST "//api.ocore.dev/api/instances/<string>/routing/adoption" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "confirmDesiredSha256": "string",
    "confirmSha256": "string",
    "planOnly": true
  }'

Accepted

{
  "jobId": 0,
  "planOnly": true
}

Was this page helpful?
Edit on GitHub

Instances

Previous Page

D N S

Next Page