Custom Provider Versions

Versions represent different releases of a custom provider. Each version can be deployed to environments.

Custom Provider Versions object

Attributes

object

String

String representing the object's type

id

String

Unique custom provider version identifier

status

StringNullable

Current version status

index

NumberNullable

Version index number

identifier

StringNullable

Version identifier

deployment

ObjectNullable

environments

Object

Environments this version is deployed to

custom_provider_id

String

ID of the parent custom provider

provider_id

StringNullable

ID of the associated provider

actor

ObjectNullable

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "object": "custom_provider.version",
  "id": "cpv_1aBcDeFgHjKlMnPq",
  "status": "queued",
  "index": 1,
  "identifier": "v1.0.0",
  "deployment": {
    "object": "custom_provider.deployment",
    "id": "cpd_1aBcDeFgHjKlMnPq",
    "status": "queued",
    "trigger": "manual",
    "custom_provider_id": "cpr_1aBcDeFgHjKlMnPq",
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "custom_provider_version_id": "cpv_1aBcDeFgHjKlMnPq",
    "commit": {
      "id": "cpcm_1aBcDeFgHjKlMnPq",
      "type": "merge",
      "message": "Deploy new version",
      "created_at": "2025-09-15T10:30:00.000Z"
    },
    "actor": {
      "id": "act_1aBcDeFgHjKlMnPq",
      "name": "John Doe",
      "type": "external",
      "organization_actor_id": "orgact_1aBcDeFgHjKlMnPq"
    },
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "environments": [
    {
      "object": "custom_provider.environment",
      "id": "cpenv_1aBcDeFgHjKlMnPq",
      "environment": {
        "object": "custom_provider.environment",
        "id": "cpenv_1aBcDeFgHjKlMnPq",
        "custom_provider_id": "cpr_1aBcDeFgHjKlMnPq",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "current_provider_version_id": "prv_4dEfGhJkLmNpQrSt",
        "instance_id": "ins_2cDeFgHjKlMnPqRs",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      }
    }
  ],
  "custom_provider_id": "cpr_1aBcDeFgHjKlMnPq",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "actor": {
    "id": "act_1aBcDeFgHjKlMnPq",
    "name": "John Doe",
    "type": "external",
    "organization_actor_id": "orgact_1aBcDeFgHjKlMnPq"
  },
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}

List custom provider versions

Returns a paginated list of versions for a custom provider.

URL Parameters

custom_provider_id

String

The unique identifier for the custom_provider

Query Parameters

limit

NumberOptional

Maximum number of items to return (1-100)

after

StringOptional

Return items after this ID

before

StringOptional

Return items before this ID

cursor

StringOptional

Pagination cursor from a previous response

order

EnumOptional

Sort order for results

status

UnionOptional

Filter by status (queued, deploying, deployment_succeeded, deployment_failed)

ids

UnionOptional

Filter by version IDs

GEThttp://api.metorial.com/custom-providers/:custom_provider_id/versions
curl -X GET "https://api.metorial.com/custom-providers/cus_Rm4Mnheq2bfEPhBhP7SY/versions" \
  -H "Authorization: Bearer metorial_sk_..."

Get custom provider version

Retrieves a specific version of a custom provider.

URL Parameters

custom_provider_id

String

The unique identifier for the custom_provider

custom_provider_version_id

String

The unique identifier for the custom_provider_version

GEThttp://api.metorial.com/custom-providers/:custom_provider_id/versions/:custom_provider_version_id
curl -X GET "https://api.metorial.com/custom-providers/cus_Rm4Mnheq2bfEPhBhP7SY/versions/cus_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create custom provider version

Creates a new version for a custom provider.

URL Parameters

custom_provider_id

String

The unique identifier for the custom_provider

Request Body

from

Object

config

ObjectOptional
POSThttp://api.metorial.com/custom-providers/:custom_provider_id/versions
curl -X POST "https://api.metorial.com/custom-providers/cus_Rm4Mnheq2bfEPhBhP7SY/versions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "from": {
    "type": "example_type",
    "image_ref": "example_image_ref",
    "username": "example_username",
    "password": "example_password"
  },
  "config": {
    "schema": {},
    "transformer": "example_transformer"
  }
}'