oCoreoCore Docs
API Reference

Deployments

Trigger a manual deployment

Creates a deployment and enqueues a build job. Accepts commit SHA, branch, or tag as the deploy target.

POST
/projects/{projectId}/deploy

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Deployment target

branchstring
commitShastring
instanceIdstring
tagstring

Path Parameters

projectIdRequiredstring

Project UUID

curl -X POST "//api.ocore.dev/api/projects/<string>/deploy" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "branch": "string",
    "commitSha": "string",
    "instanceId": "string",
    "tag": "string"
  }'

Accepted

{
  "activeColor": "string",
  "branch": "string",
  "commitAuthor": "string",
  "commitAuthorAvatar": "string",
  "commitMessage": "string",
  "commitSha": "string",
  "completedAt": "string",
  "createdAt": "string",
  "durationMs": 0,
  "errorMessage": "string",
  "evidence": [
    {
      "artifactRefs": [
        "string"
      ],
      "completedAt": "string",
      "durationMs": 0,
      "gateKey": "string",
      "logRefs": [
        "string"
      ],
      "name": "string",
      "outcome": "string",
      "required": true,
      "startedAt": "string",
      "status": "string",
      "summary": "string",
      "validation": {
        "artifactRefs": [
          "string"
        ],
        "durationMs": 0,
        "exitCode": 0,
        "failureCard": {},
        "logExcerpt": "string",
        "mode": "string",
        "profile": "string"
      },
      "waiver": {
        "actor": "string",
        "auditStatus": "string",
        "confirmation": "string",
        "expiresAt": "string",
        "id": "string",
        "reason": "string",
        "scope": "string"
      }
    }
  ],
  "findings": [
    {
      "class": "string",
      "confidence": 0,
      "evidenceExcerpt": "string",
      "gateAction": "string",
      "metadata": {},
      "severity": "string"
    }
  ],
  "id": "string",
  "imageTag": "string",
  "instanceId": "string",
  "previousCommitSha": "string",
  "previousDeploymentId": "string",
  "projectId": "string",
  "risk": {
    "level": "string",
    "score": 0
  },
  "snapshotId": "string",
  "startedAt": "string",
  "status": "string",
  "steps": [
    {
      "completedAt": "string",
      "durationMs": 0,
      "id": "string",
      "name": "string",
      "output": "string",
      "sortOrder": 0,
      "startedAt": "string",
      "status": "string",
      "version": 0
    }
  ],
  "successVerdict": {
    "clean": true,
    "label": "string",
    "legacy": true,
    "reason": "string",
    "status": "string",
    "waived": true
  },
  "triggerType": "string",
  "updatedAt": "string"
}

List project deployments

Returns a paginated list of deployments for a project.

GET
/projects/{projectId}/deployments

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

projectIdRequiredstring

Project UUID

Query Parameters

limitinteger

Results per page (default 20, max 100)

offsetinteger

Offset for pagination

curl -X GET "//api.ocore.dev/api/projects/<string>/deployments?limit=0&offset=0" \
  -H "Authorization: <token>"

OK

{
  "deployments": [
    {
      "activeColor": "string",
      "branch": "string",
      "commitAuthor": "string",
      "commitAuthorAvatar": "string",
      "commitMessage": "string",
      "commitSha": "string",
      "completedAt": "string",
      "createdAt": "string",
      "durationMs": 0,
      "errorMessage": "string",
      "evidence": [
        {
          "artifactRefs": [
            "string"
          ],
          "completedAt": "string",
          "durationMs": 0,
          "gateKey": "string",
          "logRefs": [
            "string"
          ],
          "name": "string",
          "outcome": "string",
          "required": true,
          "startedAt": "string",
          "status": "string",
          "summary": "string",
          "validation": {
            "artifactRefs": [
              "string"
            ],
            "durationMs": 0,
            "exitCode": 0,
            "failureCard": {},
            "logExcerpt": "string",
            "mode": "string",
            "profile": "string"
          },
          "waiver": {
            "actor": "string",
            "auditStatus": "string",
            "confirmation": "string",
            "expiresAt": "string",
            "id": "string",
            "reason": "string",
            "scope": "string"
          }
        }
      ],
      "findings": [
        {
          "class": "string",
          "confidence": 0,
          "evidenceExcerpt": "string",
          "gateAction": "string",
          "metadata": {},
          "severity": "string"
        }
      ],
      "id": "string",
      "imageTag": "string",
      "instanceId": "string",
      "previousCommitSha": "string",
      "previousDeploymentId": "string",
      "projectId": "string",
      "risk": {
        "level": "string",
        "score": 0
      },
      "snapshotId": "string",
      "startedAt": "string",
      "status": "string",
      "steps": [
        {
          "completedAt": "string",
          "durationMs": 0,
          "id": "string",
          "name": "string",
          "output": "string",
          "sortOrder": 0,
          "startedAt": "string",
          "status": "string",
          "version": 0
        }
      ],
      "successVerdict": {
        "clean": true,
        "label": "string",
        "legacy": true,
        "reason": "string",
        "status": "string",
        "waived": true
      },
      "triggerType": "string",
      "updatedAt": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}

Get deployment details

Returns a deployment's details including build steps and status.

GET
/projects/{projectId}/deployments/{deploymentId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

projectIdRequiredstring

Project UUID

deploymentIdRequiredstring

Deployment UUID

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

OK

{
  "activeColor": "string",
  "branch": "string",
  "commitAuthor": "string",
  "commitAuthorAvatar": "string",
  "commitMessage": "string",
  "commitSha": "string",
  "completedAt": "string",
  "createdAt": "string",
  "durationMs": 0,
  "errorMessage": "string",
  "evidence": [
    {
      "artifactRefs": [
        "string"
      ],
      "completedAt": "string",
      "durationMs": 0,
      "gateKey": "string",
      "logRefs": [
        "string"
      ],
      "name": "string",
      "outcome": "string",
      "required": true,
      "startedAt": "string",
      "status": "string",
      "summary": "string",
      "validation": {
        "artifactRefs": [
          "string"
        ],
        "durationMs": 0,
        "exitCode": 0,
        "failureCard": {},
        "logExcerpt": "string",
        "mode": "string",
        "profile": "string"
      },
      "waiver": {
        "actor": "string",
        "auditStatus": "string",
        "confirmation": "string",
        "expiresAt": "string",
        "id": "string",
        "reason": "string",
        "scope": "string"
      }
    }
  ],
  "findings": [
    {
      "class": "string",
      "confidence": 0,
      "evidenceExcerpt": "string",
      "gateAction": "string",
      "metadata": {},
      "severity": "string"
    }
  ],
  "id": "string",
  "imageTag": "string",
  "instanceId": "string",
  "previousCommitSha": "string",
  "previousDeploymentId": "string",
  "projectId": "string",
  "risk": {
    "level": "string",
    "score": 0
  },
  "snapshotId": "string",
  "startedAt": "string",
  "status": "string",
  "steps": [
    {
      "completedAt": "string",
      "durationMs": 0,
      "id": "string",
      "name": "string",
      "output": "string",
      "sortOrder": 0,
      "startedAt": "string",
      "status": "string",
      "version": 0
    }
  ],
  "successVerdict": {
    "clean": true,
    "label": "string",
    "legacy": true,
    "reason": "string",
    "status": "string",
    "waived": true
  },
  "triggerType": "string",
  "updatedAt": "string"
}

Stream build logs (SSE)

Streams build log steps as Server-Sent Events. Sends step events as they complete and a final complete event.

GET
/projects/{projectId}/deployments/{deploymentId}/logs

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

projectIdRequiredstring

Project UUID

deploymentIdRequiredstring

Deployment UUID

curl -X GET "//api.ocore.dev/api/projects/<string>/deployments/<string>/logs" \
  -H "Authorization: <token>"

SSE stream of build steps

Download build logs

Downloads the complete build log for a deployment as a text file with metadata header.

GET
/projects/{projectId}/deployments/{deploymentId}/logs/download

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

projectIdRequiredstring

Project UUID

deploymentIdRequiredstring

Deployment UUID

curl -X GET "//api.ocore.dev/api/projects/<string>/deployments/<string>/logs/download" \
  -H "Authorization: <token>"

Text file with build logs

Get deployment log summary

Returns a structured summary of the deployment log including modules, warnings, and errors.

GET
/projects/{projectId}/deployments/{deploymentId}/logs/summary

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

projectIdRequiredstring

Project UUID

deploymentIdRequiredstring

Deployment UUID

curl -X GET "//api.ocore.dev/api/projects/<string>/deployments/<string>/logs/summary" \
  -H "Authorization: <token>"

OK

{
  "durationMs": 0,
  "errorCount": 0,
  "odooVersion": "string",
  "sections": [
    {
      "endLine": 0,
      "lineCount": 0,
      "name": "string",
      "startLine": 0
    }
  ],
  "success": true,
  "totalModules": 0,
  "updatedModules": [
    "string"
  ],
  "warningCount": 0,
  "warningGroups": [
    {
      "category": "string",
      "count": 0,
      "logger": "string",
      "message": "string",
      "severity": "string"
    }
  ]
}

Trigger a rollback

Rolls back to a previous successful deployment by re-deploying its image and restoring its database snapshot.

POST
/projects/{projectId}/rollback

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Rollback target

deploymentIdstring

Path Parameters

projectIdRequiredstring

Project UUID

curl -X POST "//api.ocore.dev/api/projects/<string>/rollback" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "deploymentId": "string"
  }'

Accepted

{
  "activeColor": "string",
  "branch": "string",
  "commitAuthor": "string",
  "commitAuthorAvatar": "string",
  "commitMessage": "string",
  "commitSha": "string",
  "completedAt": "string",
  "createdAt": "string",
  "durationMs": 0,
  "errorMessage": "string",
  "evidence": [
    {
      "artifactRefs": [
        "string"
      ],
      "completedAt": "string",
      "durationMs": 0,
      "gateKey": "string",
      "logRefs": [
        "string"
      ],
      "name": "string",
      "outcome": "string",
      "required": true,
      "startedAt": "string",
      "status": "string",
      "summary": "string",
      "validation": {
        "artifactRefs": [
          "string"
        ],
        "durationMs": 0,
        "exitCode": 0,
        "failureCard": {},
        "logExcerpt": "string",
        "mode": "string",
        "profile": "string"
      },
      "waiver": {
        "actor": "string",
        "auditStatus": "string",
        "confirmation": "string",
        "expiresAt": "string",
        "id": "string",
        "reason": "string",
        "scope": "string"
      }
    }
  ],
  "findings": [
    {
      "class": "string",
      "confidence": 0,
      "evidenceExcerpt": "string",
      "gateAction": "string",
      "metadata": {},
      "severity": "string"
    }
  ],
  "id": "string",
  "imageTag": "string",
  "instanceId": "string",
  "previousCommitSha": "string",
  "previousDeploymentId": "string",
  "projectId": "string",
  "risk": {
    "level": "string",
    "score": 0
  },
  "snapshotId": "string",
  "startedAt": "string",
  "status": "string",
  "steps": [
    {
      "completedAt": "string",
      "durationMs": 0,
      "id": "string",
      "name": "string",
      "output": "string",
      "sortOrder": 0,
      "startedAt": "string",
      "status": "string",
      "version": 0
    }
  ],
  "successVerdict": {
    "clean": true,
    "label": "string",
    "legacy": true,
    "reason": "string",
    "status": "string",
    "waived": true
  },
  "triggerType": "string",
  "updatedAt": "string"
}

Was this page helpful?
Edit on GitHub

Environments

Previous Page

Project Access

Next Page