Skip to content
Hayonix

API reference · Projects

Restore an archived project

POST/v1/orgs/{org_id}/projects/{project_id}/unarchive
Console sessionproject:updateOrganization

Makes an archived project writable again. Restoring a project that is not archived returns it unchanged.

Console session only: no API key can be granted the project:update permission it needs. Requires the project:update permission (a key's scope, or a role that includes it).

Request

Path parameters

  • org_idstring

    Your organization. The SDKs and the CLI fill it in from the API key.

    ID with prefix org_

  • project_idstringrequired

    ID of the project

    ID with prefix prj_

Response

200 Project — The project

  • objectstringrequired

    Always `project`: the type of this object

    One ofproject

  • idstringrequired

    Unique ID (`prj_…`)

    ID with prefix prj_

  • org_idstringrequired

    Organization it belongs to

    ID with prefix org_

  • namestringrequired

    Its name

  • slugstringrequired

    Short URL-safe name, unique within the organization

  • descriptionstring | nullrequired

    Free-text description

  • archived_atstring (date-time) | nullrequired

    When it was archived (null while it is active) (ISO 8601, UTC)

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

  • updated_atstring (date-time)required

    When it last changed (ISO 8601, UTC)

Example response
Example response
{
  "object": "project",
  "id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "name": "string",
  "slug": "string",
  "description": "string",
  "archived_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
409conflict_errorThe resource's current state does not allow this.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.