These APIs are available to Atlassian Information Security Beta early access program customers only. The development, release, and timing of any features or functionality described herein remain at the sole discretion of Atlassian and is subject to change. If you’re not part of the program, subscribe to our Cloud roadmap to be informed about newly released and upcoming features.
The data loss prevention (DLP) REST APIs are:
Data classification is the process of identifying and categorizing data in an organization. Utilizing classification level APIs can support your organization's internal data governance by allowing you to apply various labels to your data. For example, you can create classifications based on data sensitivity, or classifications based on regulatory requirements that may apply to your organization. The choice of classification label depends on the specific requirements of your organization. Employing classification level APIs can help in establishing and enforcing rules and expectations concerning the creation, storage, management, movement, or deletion of data, both within and outside the organization.
Data classification in Atlassian products
This feature will let you categorize data within Jira and Confluence and align it with your organization's established data classification policy. It is not possible to create distinct classification levels for individual products. Once established, these classification levels will apply across Confluence and Jira. Content assigned a classification level will display a corresponding classification badge.
Classification level is a unit of data classification defined by your organization and and will be associated with specific data handling requirements (e.g. storage) that you set. For example, you can create classification levels based on your internal company policies. Classification levels will apply across your organization, which means it’s not possible to create different classification levels for separate products. There are several details of a classification level you can customize to reflect your company’s expectations.
| Detail | Explanation |
|---|---|
| Name | What the classification level is known as, for example, Confidential. |
| Definition | A user-facing description of the types of data that fall under this classification level. |
| Color | The color of the classification level badge displayed on a page or issue when it’s classified at this level. |
| Guidelines | A user-facing explanation of any rules and expectations around using, moving, or storing data classified at this level. |
| Sensitivity | A rank that determines the order in which classification levels are displayed. The most sensitive classification level should be ranked 1. |
You can create up to 10 classification levels. If you need to create more, archive a classification level to create another one.
Classification levels are always created and saved as drafts. When you’re ready for your users to start classifying Confluence pages or Jira issues, you can publish your classification levels.
Authentication is implemented via an API key. Use the API Key as a Bearer access token to authenticate the script and manage your organization. The Organization ID is used as a unique identifier in the path parameter for the organization. Copy the Organization ID and API key and keep them in a secure place. We won’t show them to you again.
To make requests to the API with the client/tool of your choice, Create an API key and get the organization ID.
A rate limit defines the maximum number of API calls an application or user can perform during a specific time frame. When this threshold is surpassed, or if CPU or total time constraints are exceeded, the application or user might encounter delays. Consequently, API requests initiated by the user or application will not succeed.
It is essential to note that all API requests are subjected to rate limits.
When a client breach the rate limit thresholds, they get HTTP 429 Too Many Requests responses. The client has to wait for the rate limit counter to reset on the server before being able to make successful requests.
Rate limit response headers
The following HTTP response headers are returned indicating the rate and threshold allowed for a client for each endpoint.
The URIs for resources have the following structure:
1 2https://api.atlassian.com/admin/<version>/dlp/<resource-name>
The DLP REST API uses pagination to conserve server resources and limit response size. If there are more results available after the current page, a link to the next page of results is included in the JSON. You can use the cursor parameter to set a specific starting point for the results.
Methods marked as experimental may change without an earlier notice. We are looking for your feedback for these methods.
There are several concepts that are common ideas with a unique meaning in Atlassian Administration. Learn more about terminology related to the cloud admin experience.
Rate this page: