Sign in
hierarchy

Read the organisation retention cap.

Changed on

The default is keep-if-either: age at most 90 days OR among the last 10 revisions of an environment. Unlimited is explicit org state, never a missing-value default.

get/api/v1/orgs/{org}/retention

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/orgs/{org}/retention
  • Auth: HTTP bearer

Response

The organisation retention cap.

mode'keep-if-either' | 'unlimited' required
max_age_secondsinteger nullable

Required for keep-if-either; absent for unlimited.

last_revisionsinteger nullable

Required for keep-if-either; absent for unlimited.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status