Archive project | Sample

1 parameter

project_idstringrequired

The ID of the project.

1 status code

200Project archived successfully.

idstringrequired

The identifier, which can be referenced in API endpoints

objectstringrequired

The object type, which is always `organization.project`

Allowed:organization.project

namestringoptional

The name of the project. This appears in reporting.

created_atintegerrequired

The Unix timestamp (in seconds) of when the project was created.

archived_atintegeroptional

The Unix timestamp (in seconds) of when the project was archived or `null`.

statusstringoptional

`active` or `archived`

external_key_idstringoptional

The external key associated with the project.

residencystringoptional

The residency configuration for the project.

Allowed:GLOBALUS_STORAGE_PROCESSINGEU_STORAGE_PROCESSINGJP_STORAGEKR_STORAGECA_STORAGESG_STORAGEIN_STORAGEAU_STORAGEGB_STORAGEAE_STORAGEAE_STORAGE_PROCESSING

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.archive.create({ projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "organization.project",
  "name": "Example Name",
  "created_at": 1,
  "archived_at": 1,
  "status": "active",
  "external_key_id": "550e8400-e29b-41d4-a716-446655440000",
  "residency": "GLOBAL"
}

Request

Response