Instances

Endpoints for listing and retrieving instances. An instance is an isolated environment within a Metorial project. Instances are created via the dashboard (since API keys are scoped to instances). Common setups include production, staging, and development instances.

Instances object

Attributes

object

String

String representing the object's type

id

String

The instance's unique identifier

slug

String

The instance's slug

name

String

The instance's name

organization_id

String

The organization's unique identifier

type

Enum

The instance's type

created_at

Date

The instance's creation date

updated_at

Date

The instance's last update date

project

Object
{
  "object": "organization.instance",
  "id": "ins_9sTuVwXyZaBcDeFg",
  "slug": "production-env",
  "name": "Production Environment",
  "organization_id": "org_7hNkPqRsTuVwXyZa",
  "type": "development",
  "created_at": "2026-01-29T12:35:22.304Z",
  "updated_at": "2026-01-29T12:35:22.304Z",
  "project": {
    "object": "organization.project",
    "id": "prj_3bCdEfGhJkLmNpQr",
    "status": "active",
    "slug": "api-integration",
    "name": "API Integration",
    "organization_id": "org_7hNkPqRsTuVwXyZa",
    "created_at": "2026-04-04T17:24:51.277Z",
    "updated_at": "2026-04-04T17:24:51.277Z"
  }
}

Get instance details

Retrieves metadata and configuration details for a specific instance.

URL Parameters

instance_id

String

The unique identifier for the instance

GEThttp://api.metorial.cominstances/:instance_id
curl -X GET "https://api.metorial.cominstances/ins_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."