{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Properties API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Properties", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Commit Application Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "commit", "value": "", "type": "path", "description": "The commit." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation retrieves a specific application property associated with a commit in a Bitbucket repository. By providing the workspace identifier, repository slug, commit hash, application key, and property name in the URL path, the API returns the value of the custom property that was previously set on that commit by a specific application. This allows applications to store and retrieve metadata or custom attributes tied to individual commits, enabling features like tracking deployment sta" }, { "info": { "name": "Atlassian Update Commit Application Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "commit", "value": "", "type": "path", "description": "The commit." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to update or set an application-specific property for a particular commit within a Bitbucket repository. By making a PUT request to this endpoint, you specify the workspace, repository slug, commit hash, application key, and property name to target a specific property associated with that commit. This is useful for storing custom metadata or application-specific information linked to a commit, such as build status, deployment information, or any other contextual dat" }, { "info": { "name": "Atlassian Delete Commit Application Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "commit", "value": "", "type": "path", "description": "The commit." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes a specific application property associated with a commit in a Bitbucket repository. This operation allows applications to delete custom metadata they previously stored against a particular commit, identified by the workspace, repository slug, commit hash, application key, and property name. Once deleted, the property and its associated value are permanently removed from the commit's application properties collection. This is useful for cleaning up outdated or no longer needed custom data" }, { "info": { "name": "Atlassian Get Repository Application Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves a specific application property stored against a Bitbucket repository within a given workspace. By providing the workspace identifier, repository slug, application key, and property name as path parameters, developers can fetch custom metadata or configuration values that have been previously set by an application for that particular repository. This is useful for applications that need to store and retrieve repository-specific settings or data, such as integration c" }, { "info": { "name": "Atlassian Update Repository Application Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an application property value for a specific repository in Bitbucket. This endpoint allows applications to store and modify custom metadata or configuration data associated with a particular repository by specifying the workspace, repository slug, application key, and property name. The operation replaces the existing property value with the new data provided in the request body, enabling applications to maintain persistent, repository-specific settings or state information that can be r" }, { "info": { "name": "Atlassian Delete Repository Application Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to delete a specific application property associated with a Bitbucket repository within a given workspace. By sending a DELETE request to the endpoint with the workspace identifier, repository slug, application key, and property name as path parameters, you can remove custom metadata or configuration data that was previously stored against the repository by a specific application. This is particularly useful for cleaning up application-specific settings, removing ob" }, { "info": { "name": "Atlassian Get Pull Request Application Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pullrequests/:pullrequest_id/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "pullrequest_id", "value": "", "type": "path", "description": "The pull request ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint retrieves a specific application property associated with a pull request in a Bitbucket repository. It requires the workspace identifier, repository slug, pull request ID, application key, and property name as path parameters to locate and return the stored property value. This operation is typically used by Bitbucket apps and integrations to read custom metadata or configuration data that has been previously attached to a pull request, enabling external applications to maintai" }, { "info": { "name": "Atlassian Update Pull Request Application Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pullrequests/:pullrequest_id/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "pullrequest_id", "value": "", "type": "path", "description": "The pull request ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows authorized applications to update or set a custom application property on a specific pull request within a Bitbucket repository. By making a PUT request to this endpoint, developers can store application-specific metadata associated with a particular pull request, using their application key and a custom property name as identifiers. The operation requires specifying the workspace, repository slug, pull request ID, application key, and property name in the URL path, ena" }, { "info": { "name": "Atlassian Delete Pull Request Application Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pullrequests/:pullrequest_id/properties/:app_key/:property_name", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The repository container; either the workspace slug or the UUID in curly braces." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "pullrequest_id", "value": "", "type": "path", "description": "The pull request ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation removes a specific application property that was previously set on a pull request in a Bitbucket repository. By making a DELETE request to this endpoint, developers can delete custom metadata or configuration data associated with a particular pull request, identified by the combination of workspace, repository slug, pull request ID, application key, and property name. This is useful for cleaning up application-specific data that apps have stored against pull requests, such as " }, { "info": { "name": "Atlassian Get User Application Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/users/:selected_user/properties/:app_key/:property_name", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Get User Application Property operation retrieves a specific application property associated with a particular Bitbucket user. This endpoint requires three path parameters: the selected_user identifier, an app_key that identifies the application storing the property, and the property_name which specifies the exact property to retrieve. Application properties are key-value pairs that applications can store against user accounts for configuration, preferences, or other application-specific dat" }, { "info": { "name": "Atlassian Update User Application Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/users/:selected_user/properties/:app_key/:property_name", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to update a specific application property for a selected user in Atlassian Bitbucket by sending a PUT request to the endpoint with the target username, application key, and property name as path parameters. The operation modifies an existing property value associated with a particular application for the specified user, enabling applications to store and manage user-specific configuration data or settings within Bitbucket's property storage system. This is useful fo" }, { "info": { "name": "Atlassian Delete User Application Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/users/:selected_user/properties/:app_key/:property_name", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to delete a specific application property associated with a Bitbucket user. By providing the selected Users identifier, the application key, and the property name in the request path, you can remove custom metadata or configuration data that was previously stored for that user within a particular application context. This is useful for cleaning up user-specific settings, removing outdated configuration values, or managing application data lifecycle when certain prop" }, { "info": { "name": "Atlassian Update Attachment Properties", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/child/attachment/:attachmentId", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the attachment is attached to." }, { "name": "attachmentId", "value": "", "type": "path", "description": "The ID of the attachment to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The Update Attachment Properties operation in the Atlassian Confluence Content API allows you to modify the metadata and properties of an existing attachment within a Confluence page or blog post. Using a PUT request to the endpoint /wiki/rest/api/content/{id}/child/attachment/{attachmentId}, you can update attributes such as the attachment's title, version information, and other custom properties without having to re-upload the actual file. This operation requires you to specify both the parent" }, { "info": { "name": "Atlassian Get Content Properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its properties." }, { "name": "key", "value": "", "type": "query", "description": "The key of the content property." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned properties." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of properties to return per page.\nNote, this may be restricted by fixed system limits." } ] }, "docs": "This API operation retrieves all properties associated with a specific Confluence content item identified by its unique ID. Properties are custom key-value pairs that can be attached to content for storing additional metadata or application-specific information. The endpoint returns a paginated list of property objects, each containing the property key, value, and version information. This is useful for applications that need to read custom data attached to pages, blog posts, or other Confluence" }, { "info": { "name": "Atlassian Create Content Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the property to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new content property for an existing Confluence content item identified by its ID. Content properties are custom key-value pairs that allow you to store additional metadata or configuration data associated with a specific piece of content such as a page, blog post, or attachment. The property must include a unique key within the scope of that content item and a value, which can be a simple string or a complex JSON object. This operation requires appropriate permissions to modify the sp" }, { "info": { "name": "Atlassian Get Content Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for the property." }, { "name": "key", "value": "", "type": "path", "description": "The key of the content property." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc." }, { "name": "status", "value": "", "type": "query", "description": "Filter the results to a set of content based on their status. If set to `any`,\ncontent with any status is returned. By default it will fetch current and archived statuses `?status=current&status=archived`.\nAll supported statuses\n\n- any\n- archived\n- current\n- deleted\n- draft\n- trashed" } ] }, "docs": "Returns a specific property from the content identified by the content ID and property key. Content properties are custom key-value pairs that can be attached to Confluence content to store additional metadata or application-specific information. This endpoint retrieves the value and details of a single property rather than listing all properties associated with the content. The property must exist on the specified content item, and the user must have permission to view the content to access its" }, { "info": { "name": "Atlassian Create Content Property for Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the property to." }, { "name": "key", "value": "", "type": "path", "description": "The key of the content property. Required." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new content property for the specified content ID and property key in Confluence. This endpoint allows you to store custom metadata or additional information associated with a specific piece of content by posting a JSON payload containing the property value. The property is identified by a unique key and is scoped to the individual content item, making it useful for storing application-specific data, custom attributes, or extended metadata that needs to be associated with pages, blog p" }, { "info": { "name": "Atlassian Update Content Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the property belongs to." }, { "name": "key", "value": "", "type": "path", "description": "The key of the property." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing content property in Atlassian Confluence by replacing its value with new data. This PUT endpoint requires both the content ID and property key to be specified in the URL path, allowing you to modify custom metadata or additional attributes attached to a specific piece of content such as a page, blog post, or attachment. The request body must contain the new property value along with its version number to ensure proper conflict handling and maintain data integrity. This operat" }, { "info": { "name": "Atlassian Delete Content Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the property belongs to." }, { "name": "key", "value": "", "type": "path", "description": "The key of the property." } ] }, "docs": "The Delete Content Property operation removes a specific property from a Confluence content item by making a DELETE request to the endpoint with the content ID and property key as path parameters. This API call permanently deletes custom metadata or additional information that was previously attached to a page, blog post, or other content type, allowing developers to clean up obsolete properties or manage content attributes programmatically. Authentication is required, and successful deletion ty" } ] } ], "bundled": true }