{ "info": { "_postman_id": "608550c7-59a2-47d8-a981-b0a0f1c07b92", "name": "Atlassian rest/atlassian-connect/1/addons/", "description": "Needs description.\n\nContact Support:\n Email: ecosystem@atlassian.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "lastUpdatedBy": "35240", "uid": "35240-608550c7-59a2-47d8-a981-b0a0f1c07b92" }, "item": [ { "name": "rest", "item": [ { "name": "atlassian-connect", "item": [ { "name": "1", "item": [ { "name": "addons", "item": [ { "name": "{addonKey}", "item": [ { "name": "properties", "item": [ { "name": "{propertyKey}", "item": [ { "name": "Atlassian Delete App Property", "id": "13b9564b-7deb-4002-a7fb-73f1bb474767", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "id": "6983b3d7-dbdc-437f-955e-bd2a3cb934a7", "key": "addonKey", "value": "", "description": "(Required) The key of the app, as defined in its descriptor." }, { "id": "5ca45ffd-1d3f-4173-ac5a-af1c3fb6f62e", "key": "propertyKey", "value": "", "description": "(Required) The key of the property." } ] }, "description": "Deletes an app's property.

**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
Additionally, Forge apps can access Connect app properties (stored against the same `app.connect.key`)." }, "response": [ { "id": "a0225df9-6794-41af-9d19-c966f7f6d488", "name": "Returned if the request is successful.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-a0225df9-6794-41af-9d19-c966f7f6d488" }, { "id": "cbae3f85-9f7a-4d7b-8bd2-c35064e73bc1", "name": "Returned if the property key is longer than 127 characters.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-cbae3f85-9f7a-4d7b-8bd2-c35064e73bc1" }, { "id": "5e73759c-8459-4e9f-ba9e-123feff65427", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-5e73759c-8459-4e9f-ba9e-123feff65427" }, { "id": "7a45d0b5-7712-4b0c-a603-bc3f6ab04485", "name": "Returned if the property is not found or doesn't belong to the app.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-7a45d0b5-7712-4b0c-a603-bc3f6ab04485" } ], "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-13b9564b-7deb-4002-a7fb-73f1bb474767" }, { "name": "Atlassian Get App Property", "id": "1c6b5dc7-4cc2-494e-a459-2549363b6dce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "id": "d58dd0b5-942c-4e74-b3bb-3e38103a9ace", "key": "addonKey", "value": "", "description": "(Required) The key of the app, as defined in its descriptor." }, { "id": "e995f543-face-427b-bcae-bdb998245f2a", "key": "propertyKey", "value": "", "description": "(Required) The key of the property." } ] }, "description": "Returns the key and value of an app's property.

**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
Additionally, Forge apps can access Connect app properties (stored against the same `app.connect.key`)." }, "response": [ { "id": "98604f85-9ec9-47cb-88d0-9d194ddc6e17", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"key\": \"\",\n \"value\": {\n \"description\": \"The value of the property. Required on create and update.\"\n }\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-98604f85-9ec9-47cb-88d0-9d194ddc6e17" }, { "id": "6b6fcb8f-da16-4148-b7f9-8d20040a8857", "name": "Returned if the property key is longer than 127 characters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-6b6fcb8f-da16-4148-b7f9-8d20040a8857" }, { "id": "c907b4f9-efd5-41b0-a598-377fe802cfb8", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-c907b4f9-efd5-41b0-a598-377fe802cfb8" }, { "id": "4d08149c-532e-4194-bb46-368493859e8e", "name": "Returned if the property is not found or doesn't belong to the app.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-4d08149c-532e-4194-bb46-368493859e8e" } ], "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-1c6b5dc7-4cc2-494e-a459-2549363b6dce" }, { "name": "Atlassian Set App Property", "id": "90f74479-6342-4e72-989a-a83fa3b63b9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "id": "30bb1a3a-e96b-42a5-ae73-8ec16309280f", "key": "addonKey", "value": "", "description": "(Required) The key of the app, as defined in its descriptor." }, { "id": "745cfad5-0973-46c0-abe9-fbee4b30d40d", "key": "propertyKey", "value": "", "description": "(Required) The key of the property." } ] }, "description": "Sets the value of an app's property. Use this resource to store custom data for your app.

The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.

**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
Additionally, Forge apps can access Connect app properties (stored against the same `app.connect.key`)." }, "response": [ { "id": "38c2594c-1752-450b-97d8-84077a2eb876", "name": "Returned if the property is updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-38c2594c-1752-450b-97d8-84077a2eb876" }, { "id": "70c8903a-0833-4e9e-85ce-ef46046fd6c2", "name": "Returned is the property is created.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-70c8903a-0833-4e9e-85ce-ef46046fd6c2" }, { "id": "cdaa5f79-bc7b-4366-b638-53871be11a1d", "name": "Returned if:\n * the property key is longer than 127 characters.\n * the value is not valid JSON.\n * the value is longer than 32768 characters.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-cdaa5f79-bc7b-4366-b638-53871be11a1d" }, { "id": "871a51ad-a434-4fc7-a67b-ae1f2ecc25fe", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties", ":propertyKey" ], "variable": [ { "key": "addonKey" }, { "key": "propertyKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-871a51ad-a434-4fc7-a67b-ae1f2ecc25fe" } ], "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-90f74479-6342-4e72-989a-a83fa3b63b9d" } ], "id": "540f403e-4f09-4aa1-857b-e41f7876fd1e", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-540f403e-4f09-4aa1-857b-e41f7876fd1e" }, { "name": "Atlassian Get App Properties", "id": "50b164f5-69ed-4a24-bba6-5e100278576b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties" ], "variable": [ { "id": "197be836-c591-48ec-b70c-26ee340162c0", "key": "addonKey", "value": "", "description": "(Required) The key of the app, as defined in its descriptor." } ] }, "description": "Gets all the properties of an app.

**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
Additionally, Forge apps can access Connect app properties (stored against the same `app.connect.key`)." }, "response": [ { "id": "1d5318f9-a58a-4880-9d57-9c83066f64e5", "name": "Returned if the request is successful.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties" ], "variable": [ { "key": "addonKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"keys\": [\n {\n \"value\": \"reference #/components/schemas/PropertyKey not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/PropertyKey not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-1d5318f9-a58a-4880-9d57-9c83066f64e5" }, { "id": "5f616a8c-5e7e-4e4b-b408-2ad4d4ec14d9", "name": "Returned if the authentication credentials are incorrect or missing.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/atlassian-connect/1/addons/:addonKey/properties", "host": [ "{{baseUrl}}" ], "path": [ "rest", "atlassian-connect", "1", "addons", ":addonKey", "properties" ], "variable": [ { "key": "addonKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-06-05T15:07:10.000Z", "updatedAt": "2026-06-05T15:07:10.000Z", "uid": "35240-5f616a8c-5e7e-4e4b-b408-2ad4d4ec14d9" } ], "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-50b164f5-69ed-4a24-bba6-5e100278576b" } ], "id": "c76f718c-7ec8-46af-899c-0b71c81effcf", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-c76f718c-7ec8-46af-899c-0b71c81effcf" } ], "id": "72ba1575-ccee-4120-967c-2d8ee12971b0", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-72ba1575-ccee-4120-967c-2d8ee12971b0" } ], "id": "2651095b-cf9c-4d69-a0d1-c88f23c8ebe4", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-2651095b-cf9c-4d69-a0d1-c88f23c8ebe4" } ], "id": "3b0c5f96-27c5-40ea-802f-09dd5e0fa3ab", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-3b0c5f96-27c5-40ea-802f-09dd5e0fa3ab" } ], "id": "bb86cfb2-6f5b-4d3a-bf59-6b2d4b1b1383", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-bb86cfb2-6f5b-4d3a-bf59-6b2d4b1b1383" } ], "id": "2d013d99-a04f-4956-bbbc-765c311a5c95", "createdAt": "2026-06-05T15:07:09.000Z", "updatedAt": "2026-06-05T15:07:09.000Z", "uid": "35240-2d013d99-a04f-4956-bbbc-765c311a5c95" } ], "variable": [ { "key": "baseUrl", "value": "https://your-domain.atlassian.net" } ] }