Sign in
Projects

Archive project

Archives a project in the organization. Archived projects cannot be used or updated.

post/organization/projects/{project_id}/archive

Path parameters

project_idstring required

The ID of the project.

Response

Project archived successfully.

idstring required

The identifier, which can be referenced in API endpoints

object'organization.project' required

The object type, which is always organization.project

namestring nullable

The name of the project. This appears in reporting.

created_atinteger required

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

archived_atinteger nullable

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

statusstring nullable

active or archived

external_key_idstring nullable

The external key associated with the project.

Changes

Changed in 2 of the 31 revisions of this API.44

  • 918e83711c9143See the full diff
    • ▲

      the response property name became optional for the status 200

      response-property-became-optional

    • ▲

      the response property status became optional for the status 200

      response-property-became-optional

    • ▲

      response property name list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property status list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      added the optional property external_key_id to the response with the 200 status

      response-optional-property-added

    • ○

      removed the active enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the archived enum value from the status response property for the response status 200

      response-property-enum-value-removed

  • fa32d6e7d9611See the full diff
    • ○

      the endpoint scheme security AdminApiKeyAuth was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog