Projects

Modify project

Modifies a project in the organization.

post/organization/projects/{project_id}

Path parameters

project_idstring required

The ID of the project.

Request body

namestring nullable

The updated name of the project, this name appears in reports.

external_key_idstring nullable

External key ID to associate with the project.

geographystring nullable

Geography for the project. Deprecated: use residency when creating a project to configure data residency. This field is retained for backward compatibility.

Response

Project updated 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.

residency'GLOBAL' | 'US_STORAGE_PROCESSING' | 'EU_STORAGE_PROCESSING' | 'JP_STORAGE' | 'KR_STORAGE' | 'CA_STORAGE' | 'SG_STORAGE' | 'IN_STORAGE' | 'AU_STORAGE' | 'GB_STORAGE' | 'AE_STORAGE' | 'AE_STORAGE_PROCESSING'

Changes

Changed in 9 of the 163 revisions of this API.8519

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the new optional request property

      new-optional-request-property

  • db5d7478feae11See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 74cbcf73838f78See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      response property archived_at 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 error/code list-of-types was widened by adding types null to media type application/json of response 400

      response-property-list-of-types-widened

    • ▲

      response property error/param list-of-types was widened by adding types null to media type application/json of response 400

      response-property-list-of-types-widened

    • ▲

      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

    • ○

      the endpoint scheme security AdminApiKeyAuth was added to the API

      api-security-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property became optional

      request-property-became-optional

    • ○

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

      request-property-list-of-types-widened

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

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

    • ▲

      added the new path request parameter project_id

      new-request-path-parameter

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      endpoint added

      endpoint-added

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