How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian App Properties API

The App Properties API from Atlassian — 3 operation(s) for app properties.

Atlassian App Properties API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include App Properties. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

Requests are made against a single base URL, https://your-domain.atlassian.net.

6 operations 3 paths 4 schemas 2 DELETE2 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian App Properties API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 2 DELETE, 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

App Properties 6
GET
/rest/atlassian-connect/1/addons/{addonKey}/properties
Atlassian Get App Properties
atlassianAddonpropertiesresourceGetaddonpropertiesGet 1 param → 200401
DELETE
/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
Atlassian Delete App Property
atlassianAddonpropertiesresourceDeleteaddonpropertyDelete 2 params → 204400401404
GET
/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
Atlassian Get App Property
atlassianAddonpropertiesresourceGetaddonpropertyGet 2 params → 200400401404
PUT
/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
Atlassian Set App Property
atlassianAddonpropertiesresourcePutaddonpropertyPut 2 params body → 200201400401
DELETE
/rest/forge/1/app/properties/{propertyKey}
Atlassian Delete App Property Forge
atlassianAddonpropertiesresourceDeleteapppropertyDelete 1 param → 204400401403404
PUT
/rest/forge/1/app/properties/{propertyKey}
Atlassian Set App Property Forge
atlassianAddonpropertiesresourcePutapppropertyPut 1 param body → 200201400401403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PropertyKey (2 properties), EntityProperty (2 properties), OperationMessage (2 properties), PropertyKeys (1 property). Each schema is shown below with its type and property counts.

PropertyKeys
object
List of property keys.
1 property
OperationMessage
object
2 properties 2 required
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
PropertyKey
object
Property key details.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-app-properties-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian App Properties API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.