Instance

Instances are independent environments within Metorial, each with its own configuration and data. Each instance is a port of a Metorial project. You can for example create production, staging, and development instances for your project.

Instance object

Attributes

object

Object

id

String

The instance's unique identifier

status

Enum

The instance's status

slug

String

The instance's slug

name

String

The instance's name

type

Enum

The instance's type

organization_id

String

The organization's unique identifier

project

Object

created_at

Date

The instance's creation date

updated_at

Date

The instance's last update date

{
  "object": "organization.instance",
  "id": "example_id",
  "status": "active",
  "slug": "example_slug",
  "name": "example_name",
  "type": "development",
  "organization_id": "example_organization_id",
  "project": {
    "object": "organization.project",
    "id": "example_id",
    "status": "active",
    "slug": "example_slug",
    "name": "example_name",
    "organization_id": "example_organization_id",
    "created_at": "2025-08-12T09:45:15.416Z",
    "updated_at": "2025-08-12T09:45:15.416Z"
  },
  "created_at": "2025-08-12T09:45:15.416Z",
  "updated_at": "2025-08-12T09:45:15.416Z"
}

Get instance details

Retrieves metadata and configuration details for a specific instance.

GEThttp://api.metorial.com/instance
curl -X GET "https://api.metorial.com/instance" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..."