MetorialDocs

Custom Provider Deployments

Deployments track the build and deployment process of custom provider versions. View deployment status and logs.

The Custom Provider Deployment object

custom_provider_deployment.json
{
  "object": "custom_provider.deployment",
  "id": "cpd_1aBcDeFgHjKlMnPq",
  "status": "failed",
  "trigger": "manual",
  "custom_provider_id": "cpr_1aBcDeFgHjKlMnPq",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "custom_provider_version_id": "cpv_1aBcDeFgHjKlMnPq",
  "commit": {
    "object": "custom_provider.deployment.commit",
    "id": "example_id",
    "type": "create_version",
    "message": "example_message",
    "created_at": "2026-10-17T09:50:02.657Z"
  },
  "immutable_bucket": {
    "object": "bucket",
    "id": "example_id",
    "is_immutable": false,
    "is_read_only": false,
    "scm_repo_link": {
      "object": "bucket.scm_repo",
      "is_linked": true,
      "path": "example_path",
      "repository": {
        "object": "scm.repository",
        "id": "example_id",
        "provider": {
          "object": "scm.provider",
          "type": "github",
          "id": "example_id",
          "name": "example_name",
          "owner": "example_owner"
        },
        "url": "example_url",
        "is_private": false,
        "default_branch": "example_default_branch",
        "created_at": "2026-10-17T09:50:02.657Z"
      }
    },
    "created_at": "2026-10-17T09:50:02.657Z"
  },
  "actor": {
    "object": "custom_provider.actor#preview",
    "id": "act_1aBcDeFgHjKlMnPq",
    "type": "external",
    "identifier": "mtea-orgact_1aBcDeFgHjKlMnPq",
    "name": "John Doe",
    "organization_actor_id": "ora_1aBcDeFgHjKlMnPq",
    "created_at": "2025-09-15T10:30:00.000Z"
  },
  "scm_push": {
    "object": "scm.push",
    "id": "example_id",
    "actor": {
      "object": "scm.actor",
      "id": "example_id",
      "external_id": "example_external_id",
      "name": "example_name",
      "email": "example_email"
    },
    "commit": {
      "object": "scm.commit",
      "id": "example_id",
      "sha": "example_sha",
      "branch": "example_branch",
      "message": "example_message",
      "created_at": "2026-10-17T09:50:02.657Z"
    },
    "repository": {
      "object": "scm.repository",
      "id": "example_id",
      "provider": {
        "object": "scm.provider",
        "type": "github",
        "id": "example_id",
        "name": "example_name",
        "owner": "example_owner"
      },
      "url": "example_url",
      "is_private": false,
      "default_branch": "example_default_branch",
      "created_at": "2026-10-17T09:50:02.657Z"
    },
    "created_at": "2026-10-17T09:50:02.657Z"
  },
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}
object"custom_provider.deployment"required
idstringrequired
status"failed" | "queued" | "deploying" | "succeeded"required
trigger"manual" | "system" | "scm"required
custom_provider_idstringrequired
provider_idstringrequirednullable
custom_provider_version_idstringrequirednullable
created_atdaterequired
updated_atdaterequired

Endpoints

List custom provider deployments

GET/custom-provider-deployments

Returns a paginated list of deployments for a custom provider.

Query parameters

status"queued" | "deploying" | "succeeded" | "failed" or "queued" | "deploying" | "succeeded" | "failed"[]optional

Filter by status (queued, deploying, succeeded, failed)

idstring or string[]optional

Filter by deployment IDs

custom_provider_version_idstring or string[]optional

Filter by version IDs

custom_provider_idstring or string[]optional

Filter by custom provider IDs

Example request

curl -X GET "https://api.metorial.com/custom-provider-deployments" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get custom provider deployment

GET/custom-provider-deployments/:custom_provider_deployment_id

Retrieves a specific deployment.

Path parameters

custom_provider_deployment_idstringrequired

The unique identifier for the custom_provider_deployment

Example request

curl -X GET "https://api.metorial.com/custom-provider-deployments/cus_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get deployment logs

GET/custom-provider-deployments/:custom_provider_deployment_id/logs

Retrieves the build and deployment logs for a deployment.

Path parameters

custom_provider_deployment_idstringrequired

The unique identifier for the custom_provider_deployment

Example request

curl -X GET "https://api.metorial.com/custom-provider-deployments/cus_Rm4Mnheq2bfEPhBhP7SY/logs" \
  -H "Authorization: Bearer metorial_sk_io2h4..."