OpenAI API (unofficial showcase)
POST/organization/projects/{project_id}/archive

Archive project

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

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
project_idstringrequired
The ID of the project.

5 status codes
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_STORAGEJP_STORAGE_PROCESSINGKR_STORAGECA_STORAGESG_STORAGEIN_STORAGEIN_STORAGE_PROCESSINGAU_STORAGEAU_STORAGE_PROCESSING
400The project is already archived or is the default project and cannot be archived.
errorobjectrequired
403The caller does not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
404The project was not found.
errorobjectrequired
429Too many management requests. Reduce the request rate and try again later.
errorobjectrequired

Error handling

A 400 is returned: The project is already archived or is the default project and cannot be archived. A 403 is returned: The caller does not have permission to perform this operation. A 404 is returned: The project was not found. A 429 is returned: Too many management requests. Reduce the request rate and try again later.