Bitbucket Properties API

The properties API from Bitbucket — 4 operation(s) for properties.

Documentation GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} Store an app property on a commit · Update a commit application property #

Ask an LLM

“How can my app save its own metadata against a commit?”

“Can I overwrite an application property value that's already on a commit?”

Tell an agent

Set property {property_name} for app {app_key} on commit {commit} in {workspace}/{repo_slug} to {attributes}.

Save {attributes} as the {app_key} app's {property_name} on commit {commit}.

DELETE /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} Delete an app property from a commit · Delete a commit application property #

Ask an LLM

“How do I remove data my app stored on a commit?”

“Can an app clean up an application property it attached to a commit?”

Tell an agent destructive · confirm first

Delete property {property_name} of app {app_key} from commit {commit} in {workspace}/{repo_slug}.

Remove the {app_key} app's {property_name} value stored on commit {commit}.

GET /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} Read an app property stored on a commit · Get a commit application property #

Ask an LLM

“How does my Connect app read data it saved against a specific commit?”

“Can I fetch an application property attached to one commit hash?”

Tell an agent

Get property {property_name} of app {app_key} on commit {commit} in {workspace}/{repo_slug}.

Read the {app_key} app's {property_name} value stored on commit {commit}.

PUT /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} Store an app property on a repository · Update a repository application property #

Ask an LLM

“How can my app persist per-repository configuration in Bitbucket?”

“Can I update an application property saved against a repository?”

Tell an agent

Set repo property {property_name} for app {app_key} on {workspace}/{repo_slug} to {attributes}.

Save {attributes} as the {app_key} app's repo-level {property_name} on {repo_slug}.

DELETE /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} Delete an app property from a repository · Delete a repository application property #

Ask an LLM

“How do I remove an application property my app stored on a repo?”

“Can an app delete its repository-level data when it's uninstalled from a repo?”

Tell an agent destructive · confirm first

Delete repo property {property_name} of app {app_key} from {workspace}/{repo_slug}.

Remove the {app_key} app's repository-level {property_name} on {repo_slug}.

GET /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} Read an app property stored on a repository · Get a repository application property #

Ask an LLM

“How does my app read settings it saved at the repository level?”

“Can I get an application property attached to a whole repo rather than a commit?”

Tell an agent

Get property {property_name} of app {app_key} on repository {workspace}/{repo_slug}.

Read the {app_key} app's repo-level {property_name} value for {repo_slug}.

PUT /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} Store an app property on a pull request · Update a pull request application property #

Ask an LLM

“How can my app attach its own state to a pull request?”

“Can I update the application property my app keeps on a PR?”

Tell an agent

Set property {property_name} for app {app_key} on pull request {pullrequest_id} in {workspace}/{repo_slug} to {attributes}.

Save {attributes} as the {app_key} app's {property_name} on PR {pullrequest_id}.

DELETE /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} Delete an app property from a pull request · Delete a pull request application property #

Ask an LLM

“How do I remove data my app saved on a pull request?”

“Can an app clear an application property from a PR once it's merged?”

Tell an agent destructive · confirm first

Delete property {property_name} of app {app_key} from pull request {pullrequest_id} in {workspace}/{repo_slug}.

Remove the {app_key} app's {property_name} value on PR {pullrequest_id}.

GET /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} Read an app property stored on a pull request · Get a pull request application property #

Ask an LLM

“How does my app read data it attached to a pull request?”

“Can I fetch an application property saved on one PR?”

Tell an agent

Get property {property_name} of app {app_key} on pull request {pullrequest_id} in {workspace}/{repo_slug}.

Read the {app_key} app's {property_name} value on PR {pullrequest_id}.

PUT /users/{selected_user}/properties/{app_key}/{property_name} Store an app property on a user · Update a user application property #

Ask an LLM

“How can my app save a setting for an individual user?”

“Can I overwrite the application property my app keeps on a user?”

Tell an agent

Set user property {property_name} for app {app_key} on {selected_user} to {attributes}.

Save {attributes} as the {app_key} app's {property_name} for user {selected_user}.

DELETE /users/{selected_user}/properties/{app_key}/{property_name} Delete an app property from a user · Delete a user application property #

Ask an LLM

“How do I delete data my app stored against a user?”

“Can an app remove a user's application property when they opt out?”

Tell an agent destructive · confirm first

Delete user property {property_name} of app {app_key} from {selected_user}.

Remove the {app_key} app's {property_name} value for user {selected_user}.

GET /users/{selected_user}/properties/{app_key}/{property_name} Read an app property stored on a user · Get a user application property #

Ask an LLM

“How does my app read per-user preferences it stored?”

“Can I get an application property saved against a specific Bitbucket user?”

Tell an agent

Get property {property_name} of app {app_key} for user {selected_user}.

Read the {app_key} app's user-level {property_name} for {selected_user}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bitbucket:bitbucket-properties-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bitbucket Properties API
  description: Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.
  version: '2.0'
  termsOfService: https://www.atlassian.com/legal/customer-agreement
  contact:
    name: Bitbucket Support
    url: https://support.atlassian.com/bitbucket-cloud/
    email: support@bitbucket.org
servers:
- url: https://api.bitbucket.org/2.0
tags:
- name: Properties
paths:
  /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}:
    put:
      responses:
        '204':
          description: An empty response.
      operationId: updateCommitHostedPropertyValue
      summary: Update a commit application property
      description: Update an application property value stored against a commit.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: commit
        description: The commit.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/application_property'
        description: The application property to create or update.
        required: true
    delete:
      responses:
        '204':
          description: An empty response.
      operationId: deleteCommitHostedPropertyValue
      summary: Delete a commit application property
      description: Delete an application property value stored against a commit.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: commit
        description: The commit.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
    get:
      responses:
        '200':
          description: The value of the property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/application_property'
      operationId: getCommitHostedPropertyValue
      summary: Get a commit application property
      description: Retrieve an application property value stored against a commit.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: commit
        description: The commit.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
  /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}:
    put:
      responses:
        '204':
          description: An empty response.
      operationId: updateRepositoryHostedPropertyValue
      summary: Update a repository application property
      description: Update an application property value stored against a repository.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/application_property'
        description: The application property to create or update.
        required: true
    delete:
      responses:
        '204':
          description: An empty response.
      operationId: deleteRepositoryHostedPropertyValue
      summary: Delete a repository application property
      description: Delete an application property value stored against a repository.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
    get:
      responses:
        '200':
          description: The value of the property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/application_property'
      operationId: getRepositoryHostedPropertyValue
      summary: Get a repository application property
      description: Retrieve an application property value stored against a repository.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
  /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}:
    put:
      responses:
        '204':
          description: An empty response.
      operationId: updatePullRequestHostedPropertyValue
      summary: Update a pull request application property
      description: Update an application property value stored against a pull request.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: pullrequest_id
        description: The pull request ID.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/application_property'
        description: The application property to create or update.
        required: true
    delete:
      responses:
        '204':
          description: An empty response.
      operationId: deletePullRequestHostedPropertyValue
      summary: Delete a pull request application property
      description: Delete an application property value stored against a pull request.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: pullrequest_id
        description: The pull request ID.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
    get:
      responses:
        '200':
          description: The value of the property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/application_property'
      operationId: getPullRequestHostedPropertyValue
      summary: Get a pull request application property
      description: Retrieve an application property value stored against a pull request.
      parameters:
      - required: true
        in: path
        name: workspace
        description: The repository container; either the workspace slug or the UUID in curly braces.
        schema:
          type: string
      - required: true
        in: path
        name: repo_slug
        description: The repository.
        schema:
          type: string
      - required: true
        in: path
        name: pullrequest_id
        description: The pull request ID.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
  /users/{selected_user}/properties/{app_key}/{property_name}:
    put:
      responses:
        '204':
          description: An empty response.
      operationId: updateUserHostedPropertyValue
      summary: Update a user application property
      description: Update an application property value stored against a user.
      parameters:
      - required: true
        in: path
        name: selected_user
        description: Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/application_property'
        description: The application property to create or update.
        required: true
    delete:
      responses:
        '204':
          description: An empty response.
      operationId: deleteUserHostedPropertyValue
      summary: Delete a user application property
      description: Delete an application property value stored against a user.
      parameters:
      - required: true
        in: path
        name: selected_user
        description: Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
    get:
      responses:
        '200':
          description: The value of the property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/application_property'
      operationId: retrieveUserHostedPropertyValue
      summary: Get a user application property
      description: Retrieve an application property value stored against a user.
      parameters:
      - required: true
        in: path
        name: selected_user
        description: Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
        schema:
          type: string
      - required: true
        in: path
        name: app_key
        description: The key of the Connect app.
        schema:
          type: string
      - required: true
        in: path
        name: property_name
        description: The name of the property.
        schema:
          type: string
      tags:
      - Properties
      security:
      - oauth2: []
      - basic: []
      - api_key: []
components:
  schemas:
    application_property:
      additionalProperties: true
      type: object
      title: Application Property
      description: "An application property. It is a caller defined JSON object that Bitbucket will store and return. \nThe `_attributes` field at its top level can be used to control who is allowed to read and update the property. \nThe keys of the JSON object must match an allowed pattern. For details, \nsee [Application properties](/cloud/bitbucket/application-properties/).\n"
      properties:
        _attributes:
          type: array
          items:
            type: string
            enum:
            - public
            - read_only
  securitySchemes:
    basic:
      type: http
      scheme: basic
      description: Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username and app password as credentials.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            repository: Read your repositories
            repository:write: Read and modify your repositories
            repository:admin: Administer your repositories
            repository:delete: Delete your repositories
            project: Read your workspace's project settings and read repositories contained within your workspace's projects
            project:admin: Read and modify settings for projects in your workspace
            email: Read your account's primary email address
            account: Read your account information
            account:write: Read and modify your account information
            team: Read your team membership information
            team:write: Read and modify your team membership information
            pipeline: Access your repositories' build pipelines
            pipeline:write: Access and rerun your repositories' build pipelines
            pipeline:variable: Access your repositories' build pipelines and configure their variables
            runner: Access your workspaces/repositories' runners
            runner:write: Access and edit your workspaces/repositories' runners
            test: Access your workspaces/repositories' test
            test:write: Access and edit your workspaces/repositories' test
            pullrequest: Read your repositories and their pull requests
            pullrequest:write: Read and modify your repositories and their pull requests
            webhook: Read and modify your repositories' webhooks
            issue: Read your repositories' issues
            issue:write: Read and modify your repositories' issues
            snippet: Read your snippets
            snippet:write: Read and modify your snippets
            wiki: Read and modify your repositories' wikis
          authorizationUrl: https://bitbucket.org/site/oauth2/authorize
          tokenUrl: https://bitbucket.org/site/oauth2/access_token
      description: OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).
    api_key:
      name: Authorization
      type: apiKey
      description: API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only available to team accounts and there is only 1 key per account. API Keys do not support scopes and have therefore access to all contents of the account.
      in: header
x-revision: 84a5dd73aa83
x-atlassian-narrative:
  documents:


# --- truncated at 32 KB (128 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/openapi/bitbucket-properties-api-openapi.yml

Bitbucket Properties API

Operations 12

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification