Custom Provider Deployments

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

Custom Provider Deployments object

Attributes

object

Enumcustom_provider.deployment

String representing the object's type

id

String

Unique custom provider deployment identifier

status

Enum

Current deployment status

trigger

Enum

What triggered this deployment

custom_provider_id

String

ID of the parent custom provider

provider_id

StringNullable

ID of the associated provider

custom_provider_version_id

StringNullable

ID of the custom provider version being deployed

commit

ObjectNullable

immutable_bucket

ObjectNullable

actor

Object

scm_push

ObjectNullable

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "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",
    "type": "create_version"
  },
  "immutable_bucket": {
    "object": "bucket",
    "scm_repo_link": {
      "object": "bucket.scm_repo",
      "is_linked": true,
      "repository": {
        "object": "scm.repository",
        "provider": {
          "object": "scm.provider",
          "type": "github"
        }
      }
    }
  },
  "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",
    "actor": {
      "object": "scm.actor"
    },
    "commit": {
      "object": "scm.commit"
    },
    "repository": {
      "object": "scm.repository",
      "provider": {
        "object": "scm.provider",
        "type": "github"
      }
    }
  },
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}

List custom provider deployments

Returns a paginated list of deployments for a custom provider.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

status

UnionOptional

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

id

UnionOptional

Filter by deployment IDs

custom_provider_version_id

UnionOptional

Filter by version IDs

custom_provider_id

UnionOptional

Filter by custom provider IDs

created_at

ObjectOptional

Filter custom provider deployment creation time by date range

updated_at

ObjectOptional

Filter custom provider deployment last update time by date range

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

Get custom provider deployment

Retrieves a specific deployment.

URL Parameters

custom_provider_deployment_id

String

The unique identifier for the custom_provider_deployment

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

Get deployment logs

Retrieves the build and deployment logs for a deployment.

URL Parameters

custom_provider_deployment_id

String

The unique identifier for the custom_provider_deployment

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