Server
    Atlassian SDK / Reference / REST APIs

    Configuration

    Postman Collection
    OpenAPI
    Operations
    GET/configuration/coveragePUT/configuration/coverageGET/configuration/denylistPUT/configuration/denylistPOST/configuration/denylistGET/configuration/retentionPUT/configuration/retentionGET/configuration/retention/filePUT/configuration/retention/file
    GET

    Get current audit log coverage configuration

    Request

    This request has no parameters.

    Responses

    Successful operation

    application/json

    AuditCoverageConfigJson
    GET/configuration/coverage
    1 2 3 curl --request GET \ --url 'https://your-domain.atlassian.net/configuration/coverage' \ --header 'Accept: application/json'
    200Response
    1 2 3 { "levelByArea": {} }
    PUT

    Set current audit log coverage configuration

    Request

    Request bodyapplication/json

    levelByArea

    object

    Responses

    Successful operation

    application/json

    AuditCoverageConfigJson
    PUT/configuration/coverage
    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": {} }'
    200Response
    1 2 3 { "levelByArea": {} }
    GET

    Get current excluded actions configuration

    Request

    This request has no parameters.

    Responses

    Successful operation

    application/json

    AuditExcludedActionsJson
    GET/configuration/denylist
    1 2 3 curl --request GET \ --url 'https://your-domain.atlassian.net/configuration/denylist' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 { "actions": [ "<string>" ] }
    PUT

    Replace existing exclude actions configuration

    Request

    Request bodyapplication/json

    actions

    array<string>

    Responses

    Successful operation

    application/json

    AuditExcludedActionsJson
    PUT/configuration/denylist
    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>" ] }'
    200Response
    1 2 3 4 5 { "actions": [ "<string>" ] }
    POST

    Modify existing excluded actions configuration

    Request

    Request bodyapplication/json

    actionsToAdd

    array<string>

    actionsToDelete

    array<string>

    Responses

    Successful operation

    application/json

    AuditExcludedActionsModifyRequestJson
    POST/configuration/denylist
    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>" ] }'
    200Response
    1 2 3 4 5 6 7 8 { "actionsToAdd": [ "<string>" ], "actionsToDelete": [ "<string>" ] }
    GET

    Get current audit log retention database configuration

    Request

    This request has no parameters.

    Responses

    Successful operation

    application/json

    AuditRetentionConfigJson
    GET/configuration/retention
    1 2 3 curl --request GET \ --url 'https://your-domain.atlassian.net/configuration/retention' \ --header 'Accept: application/json'
    200Response
    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 { "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 } }
    PUT

    Set current audit log retention database configuration

    Request

    Request bodyapplication/json

    period

    object

    Responses

    Successful operation

    application/json

    AuditRetentionConfigJson
    PUT/configuration/retention
    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 } }'
    200Response
    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 { "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 } }
    GET

    Get current audit log retention file configuration

    Request

    This request has no parameters.

    Responses

    Successful operation

    application/json

    AuditRetentionFileConfigJson
    GET/configuration/retention/file
    1 2 3 curl --request GET \ --url 'https://your-domain.atlassian.net/configuration/retention/file' \ --header 'Accept: application/json'
    200Response
    1 2 3 { "maxFileCount": 2154 }
    PUT

    Set current audit log retention file configuration

    Request

    Request bodyapplication/json

    maxFileCount

    integer

    Responses

    Successful operation

    application/json

    AuditRetentionFileConfigJson
    PUT/configuration/retention/file
    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 }'
    200Response
    1 2 3 { "maxFileCount": 2154 }

    Rate this page: