Chilkat Online Tools

PHP (Extension) / Atlassian Confluence Cloud / Set retention period

Back to Collection Items

<?php

include("chilkat.php");

$json->UpdateString('number','<integer>');$json->UpdateString('units','<string>');$json->EmitSb($sbRequestBody);$success = $http->HttpSb('PUT','https://your-domain.atlassian.net/wiki/rest/api/audit/retention',$sbRequestBody,'utf-8','application/json',$resp);$resp->GetBodySb($sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);
?>

Curl Command

curl -X PUT
	-H "Content-Type: application/json"
	-d '{
    "number": "<integer>",
    "units": "<string>"
}'
https://your-domain.atlassian.net/wiki/rest/api/audit/retention

Postman Collection Item JSON

{
  "name": "Set retention period",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"number\": \"<integer>\",\n    \"units\": \"<string>\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/audit/retention",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "audit",
        "retention"
      ]
    },
    "description": "Sets the retention period for records in the audit log. The retention period\ncan be set to a maximum of 20 years.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission."
  },
  "response": [
    {
      "name": "Returned if the retention period is updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"number\": \"<integer>\",\n    \"units\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/audit/retention",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "audit",
            "retention"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"number\": \"<integer>\",\n \"units\": \"<string>\"\n}"
    },
    {
      "name": "Returned if the calling user does not have permission to view the audit\nlog.",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"number\": \"<integer>\",\n    \"units\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/audit/retention",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "audit",
            "retention"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}