Create environment | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.accounts.createEnvironment({
        environmentType: "development",
        name: "Dev Environment Alpha",
    });
}
main();

{
  "data": {
    "api_keys": [
      {
        "created_at": "2024-04-10T08:45:00Z",
        "id": "key_abcdef1234567890",
        "name": "Dev API Key 1",
        "readonly": true,
        "scopes": [
          "admin"
        ],
        "updated_at": "2024-04-10T08:45:00Z",
        "description": "Primary API key for development environment",
        "environment": {
          "created_at": "2024-04-10T08:45:00Z",
          "environment_type": "development",
          "id": "env_1234567890abcdef",
          "name": "Dev Environment Alpha",
          "updated_at": "2024-04-10T08:45:00Z"
        },
        "environment_id": "env_1234567890abcdef",
        "integration": {
          "id": "int_clerk_001",
          "state": "active",
          "type": "clerk"
        },
        "last_used_at": "2024-04-15T12:00:00Z"
      }
    ],
    "created_at": "2024-04-10T08:45:00Z",
    "environment_type": "development",
    "id": "env_1234567890abcdef",
    "name": "Dev Environment Alpha",
    "updated_at": "2024-04-10T08:45:00Z"
  },
  "params": {}
}

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.accounts.createEnvironment({
        environmentType: "development",
        name: "Dev Environment Alpha",
    });
}
main();

{
  "data": {
    "api_keys": [
      {
        "created_at": "2024-04-10T08:45:00Z",
        "id": "key_abcdef1234567890",
        "name": "Dev API Key 1",
        "readonly": true,
        "scopes": [
          "admin"
        ],
        "updated_at": "2024-04-10T08:45:00Z",
        "description": "Primary API key for development environment",
        "environment": {
          "created_at": "2024-04-10T08:45:00Z",
          "environment_type": "development",
          "id": "env_1234567890abcdef",
          "name": "Dev Environment Alpha",
          "updated_at": "2024-04-10T08:45:00Z"
        },
        "environment_id": "env_1234567890abcdef",
        "integration": {
          "id": "int_clerk_001",
          "state": "active",
          "type": "clerk"
        },
        "last_used_at": "2024-04-15T12:00:00Z"
      }
    ],
    "created_at": "2024-04-10T08:45:00Z",
    "environment_type": "development",
    "id": "env_1234567890abcdef",
    "name": "Dev Environment Alpha",
    "updated_at": "2024-04-10T08:45:00Z"
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

environment_typeenumRequired

Allowed values:

namestringRequired1-256 characters

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3	async function main() {
4	const client = new SchematicClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.accounts.createEnvironment({
8	environmentType: "development",
9	name: "Dev Environment Alpha",
10	});
11	}
12	main();

1	{
2	"data": {
3	"api_keys": [
4	{
5	"created_at": "2024-04-10T08:45:00Z",
6	"id": "key_abcdef1234567890",
7	"name": "Dev API Key 1",
8	"readonly": true,
9	"scopes": [
10	"admin"
11	],
12	"updated_at": "2024-04-10T08:45:00Z",
13	"description": "Primary API key for development environment",
14	"environment": {
15	"created_at": "2024-04-10T08:45:00Z",
16	"environment_type": "development",
17	"id": "env_1234567890abcdef",
18	"name": "Dev Environment Alpha",
19	"updated_at": "2024-04-10T08:45:00Z"
20	},
21	"environment_id": "env_1234567890abcdef",
22	"integration": {
23	"id": "int_clerk_001",
24	"state": "active",
25	"type": "clerk"
26	},
27	"last_used_at": "2024-04-15T12:00:00Z"
28	}
29	],
30	"created_at": "2024-04-10T08:45:00Z",
31	"environment_type": "development",
32	"id": "env_1234567890abcdef",
33	"name": "Dev Environment Alpha",
34	"updated_at": "2024-04-10T08:45:00Z"
35	},
36	"params": {}
37	}