Cache
    Configuration
    Events

    Rate this page:

    Configuration

    Get current audit log coverage configuration

    GET /configuration/coverage

    Request

    There are no parameters for this request.

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://your-domain.atlassian.net/configuration/coverage' \
      --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditCoverageConfigJson

    Set current audit log coverage configuration

    PUT /configuration/coverage

    Request

    Body parameters
    levelByArea

    object

    Example

    1
    2
    3
    4
    5
    6
    7
    curl --request PUT \
      --url 'https://your-domain.atlassian.net/configuration/coverage' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
      "levelByArea": {}
    }'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditCoverageConfigJson

    Get current excluded actions configuration

    GET /configuration/denylist

    Request

    There are no parameters for this request.

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://your-domain.atlassian.net/configuration/denylist' \
      --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditExcludedActionsJson

    Replace existing exclude actions configuration

    PUT /configuration/denylist

    Request

    Body parameters
    actions

    Array<string>

    Example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    curl --request PUT \
      --url 'https://your-domain.atlassian.net/configuration/denylist' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
      "actions": [
        "<string>"
      ]
    }'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditExcludedActionsJson

    Modify existing excluded actions configuration

    POST /configuration/denylist

    Request

    Body parameters
    actionsToAdd

    Array<string>

    actionsToDelete

    Array<string>

    Example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    curl --request POST \
      --url 'https://your-domain.atlassian.net/configuration/denylist' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
      "actionsToAdd": [
        "<string>"
      ],
      "actionsToDelete": [
        "<string>"
      ]
    }'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditExcludedActionsModifyRequestJson

    Get current audit log retention database configuration

    GET /configuration/retention

    Request

    There are no parameters for this request.

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://your-domain.atlassian.net/configuration/retention' \
      --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditRetentionConfigJson

    Set current audit log retention database configuration

    PUT /configuration/retention

    Request

    Body parameters
    period

    object

    Example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    curl --request PUT \
      --url 'https://your-domain.atlassian.net/configuration/retention' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
      "period": {
        "chronology": {
          "calendarType": "<string>",
          "id": "<string>"
        },
        "days": 2154,
        "months": 2154,
        "negative": true,
        "units": [
          {
            "dateBased": true,
            "duration": {
              "nano": 2154,
              "negative": true,
              "seconds": 2154,
              "zero": true
            },
            "durationEstimated": true,
            "timeBased": true
          }
        ],
        "years": 2154,
        "zero": true
      }
    }'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditRetentionConfigJson

    Get current audit log retention file configuration

    GET /configuration/retention/file

    Request

    There are no parameters for this request.

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://your-domain.atlassian.net/configuration/retention/file' \
      --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditRetentionFileConfigJson

    Set current audit log retention file configuration

    PUT /configuration/retention/file

    Request

    Body parameters
    maxFileCount

    integer

    Format: int32

    Example

    1
    2
    3
    4
    5
    6
    7
    curl --request PUT \
      --url 'https://your-domain.atlassian.net/configuration/retention/file' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
      "maxFileCount": 2154
    }'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditRetentionFileConfigJson

    Rate this page: