From 9a6b8275d6de4068d532eb8915591f34967bada8 Mon Sep 17 00:00:00 2001 From: roost-io Date: Sun, 22 Mar 2026 14:39:37 +0000 Subject: [PATCH] Add API Tests (Postman Framework, Azure Open AI) generated by RoostGPT Using AI Model gpt-4.1 --- .../roost_postman_circle-ci_1774190351.json | 25886 ++++++++++++++++ 1 file changed, 25886 insertions(+) create mode 100644 postman_collections/circle-ci-postman/circle-ci/roost_postman_circle-ci_1774190351.json diff --git a/postman_collections/circle-ci-postman/circle-ci/roost_postman_circle-ci_1774190351.json b/postman_collections/circle-ci-postman/circle-ci/roost_postman_circle-ci_1774190351.json new file mode 100644 index 00000000..03dc1a28 --- /dev/null +++ b/postman_collections/circle-ci-postman/circle-ci/roost_postman_circle-ci_1774190351.json @@ -0,0 +1,25886 @@ +{ + "item": [ + { + "id": "6e9f0bb8-18cd-4800-abb6-8de5ce8490d4", + "name": "context", + "item": [ + { + "id": "ccdd3367-d726-48a0-aa9c-e55b4ff3c59a", + "name": "context - List contexts", + "request": { + "name": "List contexts", + "description": { + "content": "List all contexts for an owner.", + "type": "text/plain" + }, + "url": { + "path": [ + "context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "owner-id", + "value": "", + "description": "The unique ID of the owner of the context. Specify either this or owner-slug." + }, + { + "disabled": false, + "key": "owner-slug", + "value": "", + "description": "A string that represents an organization. Specify either this or owner-id. Cannot be used for accounts." + }, + { + "disabled": false, + "key": "owner-type", + "value": "", + "description": "The type of the owner. Defaults to \"organization\". Accounts are only used as context owners in server." + }, + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "d7f4acdb-2065-48bc-90f6-ea4ea1f33d5e", + "name": "A paginated list of contexts", + "originalRequest": { + "url": { + "path": [ + "context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "owner-id", + "value": "" + }, + { + "key": "owner-slug", + "value": "" + }, + { + "key": "owner-type", + "value": "" + }, + { + "key": "page-token", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"3e93a435-4bcd-8b28-f5dc-6175bfbf7c0d\",\n \"name\": \"string\",\n \"created_at\": \"2015-09-21T17:29:21.042Z\"\n },\n {\n \"id\": \"81fd3589-dec0-f556-364e-9b14d69fdea1\",\n \"name\": \"string\",\n \"created_at\": \"2015-09-21T17:29:21.042Z\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4e8cc4d-6767-47c3-b2df-618106ec9455", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "owner-id", + "value": "" + }, + { + "key": "owner-slug", + "value": "" + }, + { + "key": "owner-type", + "value": "" + }, + { + "key": "page-token", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "35031f99-1d05-4a9a-98b6-9f9f06001c28", + "name": "context - Create a new context", + "request": { + "name": "Create a new context", + "description": { + "content": "Creates a new context.", + "type": "text/plain" + }, + "url": { + "path": [ + "context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8556ea36-a2bb-4404-82ec-75f4701521a7", + "name": "The new context", + "originalRequest": { + "url": { + "path": [ + "context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"organization\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"8bcd3611-9061-69fd-e25e-ab5d4ac46ea8\",\n \"name\": \"string\",\n \"created_at\": \"2015-09-21T17:29:21.042Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "07af58cd-f600-4123-a53c-3ad5180261c8", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"organization\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a6edf44b-58f6-49b3-a7a8-965536414f02", + "name": "context/{context-id} - Get a context", + "request": { + "name": "Get a context", + "description": { + "content": "Returns basic information about a context.", + "type": "text/plain" + }, + "url": { + "path": [ + "context", + ":context-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "e889badc-f12e-4b70-b346-7101e9daaa5f", + "name": "The context", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"8bcd3611-9061-69fd-e25e-ab5d4ac46ea8\",\n \"name\": \"string\",\n \"created_at\": \"2015-09-21T17:29:21.042Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dcc83003-30a7-4abe-bb38-e735d883f68d", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e58d2983-ff77-4240-b729-01d0c38c7792", + "name": "context/{context-id} - Delete a context", + "request": { + "name": "Delete a context", + "description": {}, + "url": { + "path": [ + "context", + ":context-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "73c60cd9-bafd-4792-8f70-522b8edfcb8c", + "name": "A confirmation message", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c507cd56-c7e5-497b-ba71-65c636ff9404", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d7d5c218-88ca-4cab-b891-6123dee93087", + "name": "environment-variable", + "item": [ + { + "id": "0f24af8e-8690-4060-8ddd-93e82a8485c9", + "name": "context/{context-id}/environment-variable - List environment variables", + "request": { + "name": "List environment variables", + "description": { + "content": "List information about environment variables in a context, not including their values.", + "type": "text/plain" + }, + "url": { + "path": [ + "context", + ":context-id", + "environment-variable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "c3fda918-46a0-43e0-ac27-be8504ea1178", + "name": "A paginated list of environment variables", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id", + "environment-variable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"variable\": \"POSTGRES_USER\",\n \"created_at\": \"2015-09-21T17:29:21.042Z\",\n \"updated_at\": \"2015-09-21T17:29:21.042Z\",\n \"context_id\": \"a1800543-0cfc-ab45-bc72-98c2205a9dbb\"\n },\n {\n \"variable\": \"POSTGRES_USER\",\n \"created_at\": \"2015-09-21T17:29:21.042Z\",\n \"updated_at\": \"2015-09-21T17:29:21.042Z\",\n \"context_id\": \"bad678e4-3456-51d7-f1f7-674131e8646b\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32475433-ed24-414d-a47d-0fbf11c557b4", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id", + "environment-variable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0fa08833-2c58-473e-9216-b6bf9578e7c5", + "name": "context/{context-id}/environment-variable/{env-var-name} - Remove an environment variable", + "request": { + "name": "Remove an environment variable", + "description": { + "content": "Delete an environment variable from a context.", + "type": "text/plain" + }, + "url": { + "path": [ + "context", + ":context-id", + "environment-variable", + ":env-var-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "env-var-name", + "description": "(Required) The name of the environment variable" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "c6a27a47-be9c-4b9e-8a3a-3bf8da3d7c24", + "name": "A confirmation message", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id", + "environment-variable", + ":env-var-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "env-var-name", + "description": "(Required) The name of the environment variable" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a769adb-ef6a-4521-bb1e-02b1950411e5", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id", + "environment-variable", + ":env-var-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "env-var-name", + "description": "(Required) The name of the environment variable" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "069b1374-ba04-4dd1-bfbf-72121542f008", + "name": "context/{context-id}/environment-variable/{env-var-name} - Add or update an environment variable", + "request": { + "name": "Add or update an environment variable", + "description": { + "content": "Create or update an environment variable within a context. Returns information about the environment variable, not including its value.", + "type": "text/plain" + }, + "url": { + "path": [ + "context", + ":context-id", + "environment-variable", + ":env-var-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "env-var-name", + "description": "(Required) The name of the environment variable" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"value\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "9344c137-90ce-40f5-b3ea-a2cd5c65068c", + "name": "The new environment variable", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id", + "environment-variable", + ":env-var-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "env-var-name", + "description": "(Required) The name of the environment variable" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"value\": \"some-secret-value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"variable\": \"POSTGRES_USER\",\n \"created_at\": \"2015-09-21T17:29:21.042Z\",\n \"updated_at\": \"2015-09-21T17:29:21.042Z\",\n \"context_id\": \"316d1d16-a9d2-5db6-94c8-96509bd62d45\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "181fe42c-87e6-4546-8ece-6fc95eab1f38", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context-id", + "environment-variable", + ":env-var-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context-id", + "description": "(Required) ID of the context (UUID)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "env-var-name", + "description": "(Required) The name of the environment variable" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"value\": \"some-secret-value\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "861c10e5-28e6-4f49-aa8e-fe50e699f3e9", + "name": "{context_id}/restrictions", + "item": [ + { + "id": "075fa5cf-1bd8-498e-8a40-8201799ccaf8", + "name": "context/{context_id}/restrictions - Get context restrictions", + "request": { + "name": "Get context restrictions", + "description": { + "content": "Gets a list of project and expression restrictions associated with a context.", + "type": "text/plain" + }, + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "2d5ed9b1-7257-49fe-ba65-3d50d9f2d861", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"context_id\": \"8b2cb88d-c1ee-ddac-3799-fe09c3b1a823\",\n \"id\": \"70c2d836-3776-0933-e4c8-c5d516b62aef\",\n \"project_id\": \"7e9b6181-4b92-bcb6-b0f0-1ae41b13b1b3\",\n \"name\": \"string\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"string\"\n },\n {\n \"context_id\": \"1970caaf-da23-6813-3d57-9a77305822f1\",\n \"id\": \"b7f7ae60-5768-7349-320a-1035ec4ca2c4\",\n \"project_id\": \"870a008a-3805-ee2a-bb81-90f66af57a15\",\n \"name\": \"string\",\n \"restriction_type\": \"expression\",\n \"restriction_value\": \"string\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c1c92e75-f34a-45fc-ac51-7380f36da8d6", + "name": "Context ID provided is invalid.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"context_id is invalid.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d049d91a-1e0b-4091-83b8-225656f9f7f7", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6adf0496-b302-4bb9-bd97-dd086e8cecb1", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b726e9de-061d-4c8a-a932-4ee0ba9affb4", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f1b97e60-31e8-4f53-b687-31df5fc8b64c", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d866d5a5-5325-464a-a7fe-06ec1289b352", + "name": "context/{context_id}/restrictions - Create context restriction", + "request": { + "name": "Create context restriction", + "description": { + "content": "Creates project or expression restriction on a context.", + "type": "text/plain" + }, + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"\",\n \"restriction_type\": \"\",\n \"restriction_value\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "310e5674-7103-4ba5-bfe4-f74da977c8d1", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"name\": \"project-name\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa304738-cb0f-45a3-b2b4-a7fa13b2987f", + "name": "Bad request.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"This restriction cannot be applied to this context.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "499ce7ca-e72a-42ba-8d7a-38655b20c929", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c109fe0c-046b-408b-ae6e-bebfc96e1d3d", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7dc66c1e-da4d-4d90-a45b-49b9e94e2088", + "name": "Request conflict.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Conflict", + "code": 409, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"The restriction you're trying to add already exists.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25fc90ee-d958-4c42-8790-0aee5e920520", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d38c5f68-e769-47fc-92cd-68e3b032ad5c", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"project_id\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\",\n \"restriction_type\": \"project\",\n \"restriction_value\": \"405d8375-3514-403b-8c43-83ae74cfe0e9\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0bb19934-79dd-474c-a5e9-470e9b684f39", + "name": "context/{context_id}/restrictions - Delete context restriction", + "request": { + "name": "Delete context restriction", + "description": { + "content": "Deletes a project or expression restriction on a context.", + "type": "text/plain" + }, + "url": { + "path": [ + "context", + ":context_id", + "restrictions", + ":restriction_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "restriction_id", + "description": "(Required) An opaque identifier of a context restriction." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "95783726-2361-44ca-936a-b95f88e75a43", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions", + ":restriction_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "restriction_id", + "description": "(Required) An opaque identifier of a context restriction." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context restriction deleted.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6cd0444-43f6-434c-91ee-f5e6231167b2", + "name": "Context restriction ID provided is invalid.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions", + ":restriction_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "restriction_id", + "description": "(Required) An opaque identifier of a context restriction." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"restriction_id is invalid.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "788e253a-7c29-424e-8459-98445d9aed63", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions", + ":restriction_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "restriction_id", + "description": "(Required) An opaque identifier of a context restriction." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1aa684ff-8512-4559-b59d-bd8d5e11ab86", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions", + ":restriction_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "restriction_id", + "description": "(Required) An opaque identifier of a context restriction." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0815bdda-2624-45b5-b552-be2864de1b16", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions", + ":restriction_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "restriction_id", + "description": "(Required) An opaque identifier of a context restriction." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5e76497b-204b-4e40-9373-52a239d45ff1", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "context", + ":context_id", + "restrictions", + ":restriction_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "context_id", + "description": "(Required) An opaque identifier of a context." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "restriction_id", + "description": "(Required) An opaque identifier of a context restriction." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [] + }, + { + "id": "07339df9-6436-4e72-ba8d-a8a5e01ce5b3", + "name": "insights", + "item": [ + { + "id": "fbbddce3-8f03-4cdd-942a-25fab6a8c47c", + "name": "insights - Get summary metrics and trends for a project across it's workflows and branches", + "request": { + "name": "Get summary metrics and trends for a project across it's workflows and branches", + "description": { + "content": "Get summary metrics and trends for a project at workflow and branch level.\n Workflow runs going back at most 90 days are included in the aggregation window.\n Trends are only supported upto last 30 days.\n Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + "pages", + ":project-slug", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "reporting-window", + "value": "", + "description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "fe204d0d-8457-4d70-99f5-a8093aa9c192", + "name": "Aggregated summary metrics and trends by workflow and branches", + "originalRequest": { + "url": { + "path": [ + "insights", + "pages", + ":project-slug", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "reporting-window", + "value": "last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": {},\n \"project_id\": {},\n \"project_data\": {\n \"metrics\": {\n \"total_runs\": 690,\n \"total_duration_secs\": 3868,\n \"total_credits_used\": 920,\n \"success_rate\": 3351.615895273081,\n \"throughput\": 6053.468781838372\n },\n \"trends\": {\n \"total_runs\": 6263.28174102954,\n \"total_duration_secs\": 7071.321525965091,\n \"total_credits_used\": 9459.673538696557,\n \"success_rate\": 7345.424987667963,\n \"throughput\": 456.26889081492595\n }\n },\n \"project_workflow_data\": [\n {\n \"workflow_name\": \"build-and-test\",\n \"metrics\": {\n \"total_credits_used\": 4960,\n \"p95_duration_secs\": 967.250564609301,\n \"total_runs\": 4063,\n \"success_rate\": 1561.7687746959152\n },\n \"trends\": {\n \"total_credits_used\": 6033.471047709753,\n \"p95_duration_secs\": 9989.385871348022,\n \"total_runs\": 3439.7248577900564,\n \"success_rate\": 3062.370010415163\n }\n },\n {\n \"workflow_name\": \"build-and-test\",\n \"metrics\": {\n \"total_credits_used\": 4651,\n \"p95_duration_secs\": 760.1482104081581,\n \"total_runs\": 8765,\n \"success_rate\": 3259.121332893118\n },\n \"trends\": {\n \"total_credits_used\": 7559.503519884225,\n \"p95_duration_secs\": 5751.027349304041,\n \"total_runs\": 831.6676659209832,\n \"success_rate\": 7561.8915970840735\n }\n }\n ],\n \"project_workflow_branch_data\": [\n {\n \"workflow_name\": \"build-and-test\",\n \"branch\": \"main\",\n \"metrics\": {\n \"total_credits_used\": 6177,\n \"p95_duration_secs\": 4625.598600293614,\n \"total_runs\": 5790,\n \"success_rate\": 8856.117737562246\n },\n \"trends\": {\n \"total_credits_used\": 3805.2213518049703,\n \"p95_duration_secs\": 1694.1605324625564,\n \"total_runs\": 2395.204880258881,\n \"success_rate\": 2461.9923821736434\n }\n },\n {\n \"workflow_name\": \"build-and-test\",\n \"branch\": \"main\",\n \"metrics\": {\n \"total_credits_used\": 3177,\n \"p95_duration_secs\": 1454.8070156545489,\n \"total_runs\": 7793,\n \"success_rate\": 8905.160381768475\n },\n \"trends\": {\n \"total_credits_used\": 8312.841086451768,\n \"p95_duration_secs\": 551.4444700725219,\n \"total_runs\": 2773.90367336269,\n \"success_rate\": 2859.2710390778507\n }\n }\n ],\n \"all_branches\": [\n \"main\",\n \"main\"\n ],\n \"all_workflows\": [\n \"build-and-test\",\n \"build-and-test\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73ba09eb-2304-40f6-8120-6aef72cd6c40", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + "pages", + ":project-slug", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "reporting-window", + "value": "last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9f7a7edb-e6f2-4017-bf4e-8780bbd841f7", + "name": "insights - Job timeseries data", + "request": { + "name": "Job timeseries data", + "description": { + "content": "Get timeseries data for all jobs within a workflow. Hourly granularity data is only retained for 48 hours while daily granularity data is retained for 90 days.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + "time-series", + ":project-slug", + "workflows", + ":workflow-name", + "jobs" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "branch", + "value": "", + "description": "The name of a vcs branch. If not passed we will scope the API call to the default branch." + }, + { + "disabled": false, + "key": "granularity", + "value": "", + "description": "The granularity for which to query timeseries data." + }, + { + "disabled": false, + "key": "start-date", + "value": "", + "description": "Include only executions that started at or after this date. This must be specified if an end-date is provided." + }, + { + "disabled": false, + "key": "end-date", + "value": "", + "description": "Include only executions that started before this date. This date can be at most 90 days after the start-date." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "9a753821-f3f0-4d51-8b74-4c2f214c5c30", + "name": "An array of timeseries data, one entry per job.", + "originalRequest": { + "url": { + "path": [ + "insights", + "time-series", + ":project-slug", + "workflows", + ":workflow-name", + "jobs" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "branch", + "value": "" + }, + { + "key": "granularity", + "value": "hourly" + }, + { + "key": "start-date", + "value": "2020-08-21T13:26:29Z" + }, + { + "key": "end-date", + "value": "2020-09-04T13:26:29Z" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"next_page_token\": \"string\",\n \"items\": [\n {\n \"name\": \"build-and-test\",\n \"min_started_at\": \"1978-08-26T06:28:09.812Z\",\n \"max_ended_at\": \"1991-06-09T01:56:46.178Z\",\n \"timestamp\": \"1954-12-08T11:32:05.377Z\",\n \"metrics\": {\n \"total_runs\": 1460,\n \"failed_runs\": 4109,\n \"successful_runs\": 1080,\n \"throughput\": 5293.530413552087,\n \"median_credits_used\": 5898,\n \"total_credits_used\": 6551,\n \"duration_metrics\": {\n \"min\": 2584,\n \"median\": 5628,\n \"max\": 7344,\n \"p95\": 6918,\n \"total\": 8046\n }\n }\n },\n {\n \"name\": \"build-and-test\",\n \"min_started_at\": \"2010-04-04T11:42:19.971Z\",\n \"max_ended_at\": \"1989-07-21T08:35:26.028Z\",\n \"timestamp\": \"1965-06-02T01:14:52.767Z\",\n \"metrics\": {\n \"total_runs\": 3000,\n \"failed_runs\": 6912,\n \"successful_runs\": 1673,\n \"throughput\": 83.37145065492547,\n \"median_credits_used\": 3006,\n \"total_credits_used\": 4692,\n \"duration_metrics\": {\n \"min\": 6072,\n \"median\": 9106,\n \"max\": 2767,\n \"p95\": 7189,\n \"total\": 2067\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ff19faf-27c2-4e18-a75e-f02fd1f90d26", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + "time-series", + ":project-slug", + "workflows", + ":workflow-name", + "jobs" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "branch", + "value": "" + }, + { + "key": "granularity", + "value": "hourly" + }, + { + "key": "start-date", + "value": "2020-08-21T13:26:29Z" + }, + { + "key": "end-date", + "value": "2020-09-04T13:26:29Z" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "75738252-1364-4736-ad4f-3f6290ba8c55", + "name": "insights - Get summary metrics with trends for the entire org, and for each project.", + "request": { + "name": "Get summary metrics with trends for the entire org, and for each project.", + "description": { + "content": "Gets aggregated summary metrics with trends for the entire org.\n Also gets aggregated metrics and trends for each project belonging to the org.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":org-slug", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "reporting-window", + "value": "", + "description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug", + "description": "(Required) Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "23e7a18e-3288-4c75-a563-8d0fe515ffc5", + "name": "summary metrics with trends for an entire org and it's projects.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":org-slug", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "reporting-window", + "value": "last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug", + "description": "(Required) Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_data\": {\n \"metrics\": {\n \"total_runs\": 6800,\n \"total_duration_secs\": 3214,\n \"total_credits_used\": 483,\n \"success_rate\": 9111.416625687049,\n \"throughput\": 8665.287912999447\n },\n \"trends\": {\n \"total_runs\": 4152.756948855385,\n \"total_duration_secs\": 2501.8728246655874,\n \"total_credits_used\": 5565.794214169788,\n \"success_rate\": 7922.024173026459,\n \"throughput\": 5275.8013024749625\n }\n },\n \"org_project_data\": [\n {\n \"project_name\": \"api-preview-docs\",\n \"metrics\": {\n \"total_credits_used\": 3155,\n \"total_duration_secs\": 8879,\n \"total_runs\": 3718,\n \"success_rate\": 7557.5450164007925\n },\n \"trends\": {\n \"total_credits_used\": 7652.026568455288,\n \"total_duration_secs\": 148.81584413864334,\n \"total_runs\": 6016.232662218251,\n \"success_rate\": 4513.6569110055125\n }\n },\n {\n \"project_name\": \"api-preview-docs\",\n \"metrics\": {\n \"total_credits_used\": 6692,\n \"total_duration_secs\": 8366,\n \"total_runs\": 9816,\n \"success_rate\": 257.689734790425\n },\n \"trends\": {\n \"total_credits_used\": 8061.2471081675685,\n \"total_duration_secs\": 4650.560416480372,\n \"total_runs\": 6964.6303077206585,\n \"success_rate\": 1174.7368153322425\n }\n }\n ],\n \"all_projects\": [\n \"string\",\n \"string\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f6a2aa38-f0d0-4e4a-ab06-35a907c2f52b", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":org-slug", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "reporting-window", + "value": "last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug", + "description": "(Required) Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0e96ce13-2d62-40e3-bca5-8f881d0350a4", + "name": "insights/{project-slug} - Get all branches for a project", + "request": { + "name": "Get all branches for a project", + "description": { + "content": "Get a list of all branches for a specified project. The list will only contain branches currently available within Insights. The maximum number of branches returned by this endpoint is 5,000.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":project-slug", + "branches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "workflow-name", + "value": "", + "description": "The name of a workflow. If not passed we will scope the API call to the project." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "1685a472-7751-4ba8-94ac-ce3a26c7937a", + "name": "A list of branches for a project", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "branches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "workflow-name", + "value": "build-and-test" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": {},\n \"project_id\": {},\n \"branches\": [\n \"main\",\n \"main\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7c7b1198-1635-40e8-a510-1201060190c6", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "branches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "workflow-name", + "value": "build-and-test" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "16d39ee9-d702-47e1-b03e-0367015f745f", + "name": "insights/{project-slug} - Get flaky tests for a project", + "request": { + "name": "Get flaky tests for a project", + "description": { + "content": "Get a list of flaky tests for a given project. Flaky tests are branch agnostic.\n A flaky test is a test that passed and failed in the same commit.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":project-slug", + "flaky-tests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "7718c5d1-00da-48a5-9298-6e722b22dd8b", + "name": "A list of flaky tests for a project", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "flaky-tests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"flaky-tests\": [\n {\n \"workflow-created-at\": \"string\",\n \"classname\": \"string\",\n \"job-number\": 1938,\n \"times-flaked\": 526,\n \"source\": \"string\",\n \"pipeline-number\": 6698,\n \"file\": \"string\",\n \"workflow-name\": \"string\",\n \"job-name\": \"string\",\n \"workflow-id\": {},\n \"test-name\": \"string\",\n \"time-wasted\": 4187\n },\n {\n \"workflow-created-at\": \"string\",\n \"classname\": \"string\",\n \"job-number\": 623,\n \"times-flaked\": 7313,\n \"source\": \"string\",\n \"pipeline-number\": 7736,\n \"file\": \"string\",\n \"workflow-name\": \"string\",\n \"job-name\": \"string\",\n \"workflow-id\": {},\n \"test-name\": \"string\",\n \"time-wasted\": 4923\n }\n ],\n \"total-flaky-tests\": 5\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "313d95d6-76b6-458b-ab64-8a2191200611", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "flaky-tests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9423aab3-466a-4523-867e-b6c70e5ce819", + "name": "workflows", + "item": [ + { + "id": "80568c3a-6c88-4430-aee9-66a94fa06fdb", + "name": "insights/{project-slug}/workflows - Get summary metrics for a project's workflows", + "request": { + "name": "Get summary metrics for a project's workflows", + "description": { + "content": "Get summary metrics for a project's workflows. Workflow runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":project-slug", + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + }, + { + "disabled": false, + "key": "all-branches", + "value": "", + "description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter." + }, + { + "disabled": false, + "key": "branch", + "value": "", + "description": "The name of a vcs branch. If not passed we will scope the API call to the default branch." + }, + { + "disabled": false, + "key": "reporting-window", + "value": "", + "description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "0d9e61e0-aaf8-420a-bb39-37c22f5eed32", + "name": "A paginated list of summary metrics by workflow", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + }, + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "reporting-window", + "value": "last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"name\": \"build-and-test\",\n \"metrics\": {\n \"total_runs\": 5517,\n \"successful_runs\": 5992,\n \"mttr\": 4031,\n \"total_credits_used\": 4912,\n \"failed_runs\": 514,\n \"success_rate\": 3660.738453869985,\n \"duration_metrics\": {\n \"min\": 7662,\n \"mean\": 4041,\n \"median\": 1103,\n \"p95\": 2244,\n \"max\": 5975,\n \"standard_deviation\": 3577.0678285850922\n },\n \"total_recoveries\": 7145,\n \"throughput\": 2654.3255650979213\n },\n \"window_start\": \"1972-12-29T21:13:15.192Z\",\n \"window_end\": \"1971-01-06T03:05:20.914Z\",\n \"project_id\": {}\n },\n {\n \"name\": \"build-and-test\",\n \"metrics\": {\n \"total_runs\": 9614,\n \"successful_runs\": 9045,\n \"mttr\": 1780,\n \"total_credits_used\": 4082,\n \"failed_runs\": 4092,\n \"success_rate\": 5493.756304530333,\n \"duration_metrics\": {\n \"min\": 231,\n \"mean\": 3677,\n \"median\": 422,\n \"p95\": 6314,\n \"max\": 7532,\n \"standard_deviation\": 5994.762254048347\n },\n \"total_recoveries\": 3142,\n \"throughput\": 8639.370965194315\n },\n \"window_start\": \"1968-08-02T09:11:07.222Z\",\n \"window_end\": \"1997-02-04T10:49:41.269Z\",\n \"project_id\": {}\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "88e7cef7-dfdb-4418-955c-07a497717456", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + }, + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "reporting-window", + "value": "last-90-days" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8c030599-7fb8-4a55-a590-3f117422590a", + "name": "insights/{project-slug}/workflows/{workflow-name} - Get recent runs of a workflow", + "request": { + "name": "Get recent runs of a workflow", + "description": { + "content": "Get recent runs of a workflow. Runs going back at most 90 days are returned. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "all-branches", + "value": "", + "description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter." + }, + { + "disabled": false, + "key": "branch", + "value": "", + "description": "The name of a vcs branch. If not passed we will scope the API call to the default branch." + }, + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + }, + { + "disabled": false, + "key": "start-date", + "value": "", + "description": "Include only executions that started at or after this date. This must be specified if an end-date is provided." + }, + { + "disabled": false, + "key": "end-date", + "value": "", + "description": "Include only executions that started before this date. This date can be at most 90 days after the start-date." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "cb8077ae-22f0-485b-8c36-8ec166f91dbb", + "name": "A paginated list of recent workflow runs", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "page-token", + "value": "" + }, + { + "key": "start-date", + "value": "2020-08-21T13:26:29Z" + }, + { + "key": "end-date", + "value": "2020-09-04T13:26:29Z" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"a34997d2-9ec6-ad27-701c-232c1588b1d6\",\n \"branch\": \"main\",\n \"duration\": 5161,\n \"created_at\": \"1967-09-09T10:06:34.278Z\",\n \"stopped_at\": \"1955-06-02T12:33:19.174Z\",\n \"credits_used\": 8158,\n \"status\": \"unauthorized\",\n \"is_approval\": false\n },\n {\n \"id\": \"6ba15a3c-bc0d-17b6-dce5-cc2987ba956f\",\n \"branch\": \"main\",\n \"duration\": 9255,\n \"created_at\": \"1963-08-27T10:24:44.265Z\",\n \"stopped_at\": \"1982-10-05T11:41:01.703Z\",\n \"credits_used\": 380,\n \"status\": \"failed\",\n \"is_approval\": false\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aaa3bc00-9cb5-49c8-9312-8a46da60e641", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "page-token", + "value": "" + }, + { + "key": "start-date", + "value": "2020-08-21T13:26:29Z" + }, + { + "key": "end-date", + "value": "2020-09-04T13:26:29Z" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1de8be0c-34be-48a8-9422-034b599f94e1", + "name": "insights/{project-slug}/workflows/{workflow-name} - Get summary metrics for a project workflow's jobs.", + "request": { + "name": "Get summary metrics for a project workflow's jobs.", + "description": { + "content": "Get summary metrics for a project workflow's jobs. Job runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "jobs" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + }, + { + "disabled": false, + "key": "all-branches", + "value": "", + "description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter." + }, + { + "disabled": false, + "key": "branch", + "value": "", + "description": "The name of a vcs branch. If not passed we will scope the API call to the default branch." + }, + { + "disabled": false, + "key": "reporting-window", + "value": "", + "description": "The time window used to calculate summary metrics. If not provided, defaults to last-90-days" + }, + { + "disabled": false, + "key": "job-name", + "value": "", + "description": "The name of the jobs you would like to filter from your workflow. If not specified, all workflow jobs will be returned. The job name can either be the full job name or just a substring of the job name." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "b481018a-8aff-4d3f-9a8b-4baefd143415", + "name": "A paginated list of summary metrics by workflow job.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "jobs" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + }, + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "reporting-window", + "value": "last-90-days" + }, + { + "key": "job-name", + "value": "lint" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"name\": \"string\",\n \"metrics\": {\n \"total_runs\": 8889,\n \"failed_runs\": 2488,\n \"successful_runs\": 5418,\n \"duration_metrics\": {\n \"min\": 6093,\n \"mean\": 5155,\n \"median\": 4483,\n \"p95\": 5145,\n \"max\": 8899,\n \"standard_deviation\": 8978.619808389034\n },\n \"success_rate\": 9949.041832535868,\n \"total_credits_used\": 108,\n \"throughput\": 3155.0235274541706\n },\n \"window_start\": \"1959-12-14T12:36:42.051Z\",\n \"window_end\": \"1996-11-11T14:14:39.354Z\"\n },\n {\n \"name\": \"string\",\n \"metrics\": {\n \"total_runs\": 7716,\n \"failed_runs\": 9811,\n \"successful_runs\": 2244,\n \"duration_metrics\": {\n \"min\": 6258,\n \"mean\": 4356,\n \"median\": 932,\n \"p95\": 48,\n \"max\": 1504,\n \"standard_deviation\": 5868.424766427654\n },\n \"success_rate\": 4852.285857497456,\n \"total_credits_used\": 5323,\n \"throughput\": 1496.810967119828\n },\n \"window_start\": \"1952-02-25T14:27:15.707Z\",\n \"window_end\": \"1997-09-23T16:47:42.650Z\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26ed045d-dadc-4f61-9f86-7cf548f1bb2d", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "jobs" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + }, + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "reporting-window", + "value": "last-90-days" + }, + { + "key": "job-name", + "value": "lint" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "05114503-fe53-4d31-983d-dd85b331b287", + "name": "insights/{project-slug}/workflows/{workflow-name} - Get metrics and trends for workflows", + "request": { + "name": "Get metrics and trends for workflows", + "description": { + "content": "Get the metrics and trends for a particular workflow on a single branch or all branches", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "all-branches", + "value": "", + "description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter." + }, + { + "disabled": false, + "key": "branch", + "value": "", + "description": "The name of a vcs branch. If not passed we will scope the API call to the default branch." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "26e36d05-208c-4127-bee9-ff0947a93b1e", + "name": "Metrics and trends for a workflow", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"metrics\": {\n \"total_runs\": 6854,\n \"successful_runs\": 7466,\n \"mttr\": 7687,\n \"total_credits_used\": 3715,\n \"failed_runs\": 6659,\n \"success_rate\": 4629.024087582603,\n \"window_start\": \"1985-09-07T23:01:55.307Z\",\n \"duration_metrics\": {\n \"min\": 3974,\n \"mean\": 9672,\n \"median\": 9646,\n \"p95\": 441,\n \"max\": 5791,\n \"standard_deviation\": 1003.4119686294551\n },\n \"window_end\": \"2014-12-31T16:47:35.763Z\",\n \"throughput\": 4442.975293009248,\n \"completed_runs\": 564\n },\n \"trends\": {\n \"total_runs\": 4264.3435515540305,\n \"failed_runs\": 9569.477945405804,\n \"success_rate\": 1031.567295878437,\n \"p95_duration_secs\": 8007.927768805858,\n \"median_duration_secs\": 1568.6389957406454,\n \"total_credits_used\": 3272.3526772400423,\n \"mttr\": 3244.65279292973,\n \"throughput\": 5586.13963772038\n },\n \"workflow_names\": [\n \"string\",\n \"string\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6cb6142-a789-48db-ac83-16882727bb81", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "all-branches", + "value": "" + }, + { + "key": "branch", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1f224e56-bdae-4cd6-b4d3-d1e503c36200", + "name": "insights/{project-slug}/workflows/{workflow-name} - Get test metrics for a project's workflows", + "request": { + "name": "Get test metrics for a project's workflows", + "description": { + "content": "Get test metrics for a project's workflows. Currently tests metrics are calculated based on 10 most recent workflow runs.", + "type": "text/plain" + }, + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "test-metrics" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "branch", + "value": "", + "description": "The name of a vcs branch. If not passed we will scope the API call to the default branch." + }, + { + "disabled": false, + "key": "all-branches", + "value": "", + "description": "Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "4ea0068a-b1ff-41dc-bd7e-340cf4d67af2", + "name": "A list of test metrics by workflow", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "test-metrics" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "branch", + "value": "" + }, + { + "key": "all-branches", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"average_test_count\": 9999,\n \"most_failed_tests\": [\n {\n \"failed_runs\": 2148,\n \"job_name\": \"string\",\n \"p95_duration\": 3876.12690745341,\n \"test_name\": \"string\",\n \"file\": \"string\",\n \"source\": \"string\",\n \"classname\": \"string\",\n \"total_runs\": 5334,\n \"flaky\": true\n },\n {\n \"failed_runs\": 7814,\n \"job_name\": \"string\",\n \"p95_duration\": 4289.356206938844,\n \"test_name\": \"string\",\n \"file\": \"string\",\n \"source\": \"string\",\n \"classname\": \"string\",\n \"total_runs\": 3264,\n \"flaky\": false\n }\n ],\n \"most_failed_tests_extra\": 8540,\n \"slowest_tests\": [\n {\n \"failed_runs\": 3991,\n \"job_name\": \"string\",\n \"p95_duration\": 3133.423287516566,\n \"test_name\": \"string\",\n \"file\": \"string\",\n \"source\": \"string\",\n \"classname\": \"string\",\n \"total_runs\": 749,\n \"flaky\": false\n },\n {\n \"failed_runs\": 6153,\n \"job_name\": \"string\",\n \"p95_duration\": 9827.621803539683,\n \"test_name\": \"string\",\n \"file\": \"string\",\n \"source\": \"string\",\n \"classname\": \"string\",\n \"total_runs\": 5706,\n \"flaky\": false\n }\n ],\n \"slowest_tests_extra\": 2757,\n \"total_test_runs\": 4278,\n \"test_runs\": [\n {\n \"pipeline_number\": 1545,\n \"workflow_id\": {},\n \"success_rate\": 3935.1636899453247,\n \"test_counts\": {\n \"error\": 2471,\n \"failure\": 1085,\n \"skipped\": 6359,\n \"success\": 9416,\n \"total\": 9792\n }\n },\n {\n \"pipeline_number\": 8193,\n \"workflow_id\": {},\n \"success_rate\": 8257.81225527523,\n \"test_counts\": {\n \"error\": 7850,\n \"failure\": 5214,\n \"skipped\": 2679,\n \"success\": 2372,\n \"total\": 2354\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bcc8348-8542-479e-9fcb-de01c450d6ca", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "insights", + ":project-slug", + "workflows", + ":workflow-name", + "test-metrics" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "branch", + "value": "" + }, + { + "key": "all-branches", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "workflow-name", + "description": "(Required) The name of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [] + }, + { + "id": "17495f93-cc31-4ad5-bf94-8a16f3f80d2f", + "name": "Cancel job by job ID", + "request": { + "name": "Cancel job by job ID", + "description": { + "content": "Cancel job with a given job ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "jobs", + ":job-id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-id", + "description": "(Required) The unique ID of the job." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null + }, + "response": [ + { + "id": "e66d7343-6816-4600-b720-cd52decfc9c3", + "name": "Job cancelled successfully.", + "originalRequest": { + "url": { + "path": [ + "jobs", + ":job-id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-id", + "description": "(Required) The unique ID of the job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12015e9b-9296-48cb-8eb9-cf7e09a4962f", + "name": "Bad request error.", + "originalRequest": { + "url": { + "path": [ + "jobs", + ":job-id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-id", + "description": "(Required) The unique ID of the job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f523f72a-dccd-4c79-9bd6-3a8f6ce93a7f", + "name": "Unauthorized error.", + "originalRequest": { + "url": { + "path": [ + "jobs", + ":job-id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-id", + "description": "(Required) The unique ID of the job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17ec7926-8e21-47ca-a8b7-b5562ebaae46", + "name": "Forbidden error.", + "originalRequest": { + "url": { + "path": [ + "jobs", + ":job-id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-id", + "description": "(Required) The unique ID of the job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35bce5ba-87cf-4ad8-ba44-1389030181ad", + "name": "Job not found error.", + "originalRequest": { + "url": { + "path": [ + "jobs", + ":job-id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-id", + "description": "(Required) The unique ID of the job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cc55540-0f23-4a8d-ac75-4439bc3fa884", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "jobs", + ":job-id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-id", + "description": "(Required) The unique ID of the job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4a668008-d63b-42c7-b002-700e9a062997", + "name": "me", + "item": [ + { + "id": "60a382e7-f84d-401c-858f-4f1b56667a61", + "name": "me - User Information", + "request": { + "name": "User Information", + "description": { + "content": "Provides information about the user that is currently signed in.", + "type": "text/plain" + }, + "url": { + "path": [ + "me" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "0bce72ac-9fe2-499c-af98-c3d2935fc335", + "name": "User login information.", + "originalRequest": { + "url": { + "path": [ + "me" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"72aaab65-2206-57dc-8690-7df99bc9b3b8\",\n \"login\": \"string\",\n \"name\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ad71df98-5d94-4d85-b402-9598915464c5", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "me" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "87989220-17c2-4d9b-8cfb-587b5f6f9f27", + "name": "me - Collaborations", + "request": { + "name": "Collaborations", + "description": { + "content": "Provides the set of organizations of which a user is a member or a collaborator.\n\nThe set of organizations that a user can collaborate on is composed of:\n\n* Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub)\n* The parent organization of repository that the user can collaborate on, but is not necessarily a member of\n* The organization of the current user's account", + "type": "text/plain" + }, + "url": { + "path": [ + "me", + "collaborations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "c65009ae-0ce8-41ea-ae5a-7b9b74dc6960", + "name": "Collaborations", + "originalRequest": { + "url": { + "path": [ + "me", + "collaborations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"510cea56-50fd-0f16-d033-c8448c332ce1\",\n \"vcs-type\": \"string\",\n \"name\": \"string\",\n \"avatar_url\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"e007870f-7c6f-1214-dfe2-94af9ec52734\",\n \"vcs-type\": \"string\",\n \"name\": \"string\",\n \"avatar_url\": \"string\",\n \"slug\": \"string\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d08f543b-f162-4ef5-a569-ac967f9674a9", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "me", + "collaborations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "57ce8f80-c24e-4331-833f-3c94ce832f61", + "name": "organization", + "item": [ + { + "id": "2a03560b-652a-47d7-b4b9-39970b8f4dfa", + "name": "organization - Create a new organization", + "request": { + "name": "Create a new organization", + "description": { + "content": "[EXPERIMENTAL] Create a new organization. For VCS providers (GitHub/Bitbucket), this validates access and syncs org data. For standalone orgs, this creates a new CircleCI organization.", + "type": "text/plain" + }, + "url": { + "path": [ + "organization" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"vcs_type\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "852c168c-6bcc-4806-b963-2008651c60e0", + "name": "The newly created organization", + "originalRequest": { + "url": { + "path": [ + "organization" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"vcs_type\": \"github\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"vcs_type\": \"github\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "582dfe04-61ba-4526-8f30-5ce3c2de261a", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "organization" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"vcs_type\": \"github\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "bf31b4b6-7156-4d97-aff0-432a6455293b", + "name": "organization/{org-slug-or-id} - Delete an organization", + "request": { + "name": "Delete an organization", + "description": { + "content": "[EXPERIMENTAL] Delete an organization. This action will delete all projects including all build data for the organization.", + "type": "text/plain" + }, + "url": { + "path": [ + "organization", + ":org-slug-or-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "0e267c45-cba2-4e3c-9c86-171bce79f5bf", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae7cd32f-5401-4ff6-ab10-ab40b2af12f1", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "02e682a2-f5d4-4731-b6d4-7cf5c2b0c3af", + "name": "organization/{org-slug-or-id} - Create a new project", + "request": { + "name": "Create a new project", + "description": { + "content": "Create a new project. Works for all organization types.", + "type": "text/plain" + }, + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7140c7c4-378c-40ac-b1fe-19b8263f04e8", + "name": "The new project", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"api-preview-docs\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"name\": \"api-preview-docs\",\n \"id\": \"123656f3-8e25-7e40-b262-5d7cde425c84\",\n \"organization_name\": \"CircleCI-Public\",\n \"organization_slug\": \"gh/CircleCI-Public\",\n \"organization_id\": \"ec6887ec-7d44-4b31-b468-7e552408ee32\",\n \"vcs_info\": {\n \"vcs_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"provider\": \"CircleCI\",\n \"default_branch\": \"main\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ac1455d-8d10-4337-8efd-2be6f3bc0aff", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"api-preview-docs\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "397a03cd-b2d5-49d4-8fa4-ce5aadaa0519", + "name": "url-orb-allow-list", + "item": [ + { + "id": "368ca8a3-95d4-4ecf-97aa-d476d728517e", + "name": "organization/{org-slug-or-id}/url-orb-allow-list - List the entries in the org's URL Orb allow-list", + "request": { + "name": "List the entries in the org's URL Orb allow-list", + "description": { + "content": "List the entries in the org's URL Orb allow-list", + "type": "text/plain" + }, + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "fe8ad41a-fae6-44d2-b900-3a0e3c1b7a06", + "name": "URL Orb allow-list entries", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"ba98990a-5a00-4cad-b55e-b44117b92e0c\",\n \"name\": \"Allow URL orbs from raw.githubusercontent.com/CircleCI-Public\",\n \"prefix\": {},\n \"auth\": \"github-app\"\n },\n {\n \"id\": \"ba98990a-5a00-4cad-b55e-b44117b92e0c\",\n \"name\": \"Allow URL orbs from raw.githubusercontent.com/CircleCI-Public\",\n \"prefix\": {},\n \"auth\": \"github-app\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "60d1e844-4cc0-4d51-8e56-017fcfa50b29", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c9fa5b67-7697-4eb8-b0b3-244e297cda8b", + "name": "organization/{org-slug-or-id}/url-orb-allow-list - Create a new URL Orb allow-list entry", + "request": { + "name": "Create a new URL Orb allow-list entry", + "description": { + "content": "Create a new URL Orb allow-list entry", + "type": "text/plain" + }, + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"prefix\": {},\n \"auth\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3aaecae2-7887-4dbf-8d92-566e71b49f5e", + "name": "The ID of the new URL Orb allow-list entry", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Allow URL orbs from raw.githubusercontent.com/CircleCI-Public\",\n \"prefix\": {},\n \"auth\": \"github-app\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"ba98990a-5a00-4cad-b55e-b44117b92e0c\",\n \"message\": \"Created.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9e07279b-5f32-48ad-9cd6-6970b606d209", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Allow URL orbs from raw.githubusercontent.com/CircleCI-Public\",\n \"prefix\": {},\n \"auth\": \"github-app\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "725958c3-4ac2-48df-98ab-21aa2af35466", + "name": "organization/{org-slug-or-id}/url-orb-allow-list - Remove an entry from the org's URL orb allow-list", + "request": { + "name": "Remove an entry from the org's URL orb allow-list", + "description": { + "content": "Remove an entry from the org's URL orb allow-list", + "type": "text/plain" + }, + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list", + ":allow-list-entry-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "allow-list-entry-id", + "description": "(Required) URL orb allow-list entry UUID." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "387819af-73ab-459f-8feb-5fa2fd3a3a59", + "name": "The ID of the removed URL Orb allow-list entry", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list", + ":allow-list-entry-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "allow-list-entry-id", + "description": "(Required) URL orb allow-list entry UUID." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"ba98990a-5a00-4cad-b55e-b44117b92e0c\",\n \"message\": \"Created.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1b34fbf4-7c75-4d88-8953-4c8824c28065", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "organization", + ":org-slug-or-id", + "url-orb-allow-list", + ":allow-list-entry-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org-slug-or-id", + "description": "(Required) Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "allow-list-entry-id", + "description": "(Required) URL orb allow-list entry UUID." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [] + }, + { + "id": "980a77de-442d-4b7f-8164-ad518b1743a0", + "name": "pipeline", + "item": [ + { + "id": "10a0d4e2-5426-4216-b9fd-5522f59dbeb0", + "name": "pipeline - Get a list of pipelines", + "request": { + "name": "Get a list of pipelines", + "description": { + "content": "Returns all pipelines for the most recently built projects (max 250) you follow in an organization.", + "type": "text/plain" + }, + "url": { + "path": [ + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "org-slug", + "value": "", + "description": "Org slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)." + }, + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + }, + { + "disabled": false, + "key": "mine", + "value": "", + "description": "Only include entries created by your user." + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "92ec1f42-1195-4c94-801f-fa953df2c641", + "name": "A sequence of pipelines.", + "originalRequest": { + "url": { + "path": [ + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "org-slug", + "value": "gh/CircleCI-Public" + }, + { + "key": "page-token", + "value": "" + }, + { + "key": "mine", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"2003-09-04T11:16:44.251Z\",\n \"errors\": [\n {\n \"type\": \"other\",\n \"message\": \"string\"\n },\n {\n \"type\": \"invalid-trigger-setup\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"setup\",\n \"trigger\": {\n \"type\": \"api\",\n \"received_at\": \"1976-12-02T08:19:06.483Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"2024-09-02T17:17:17.727Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n },\n {\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"1947-09-07T21:23:33.927Z\",\n \"errors\": [\n {\n \"type\": \"invalid-trigger-setup\",\n \"message\": \"string\"\n },\n {\n \"type\": \"permission\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"setup-pending\",\n \"trigger\": {\n \"type\": \"webhook\",\n \"received_at\": \"1950-07-22T02:28:17.203Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"1981-12-21T17:44:48.956Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c43b361-3288-4895-a3ba-bf4a67248ed2", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "org-slug", + "value": "gh/CircleCI-Public" + }, + { + "key": "page-token", + "value": "" + }, + { + "key": "mine", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "43d7cb2a-1833-440d-95db-4cc86813651e", + "name": "pipeline - Continue a pipeline", + "request": { + "name": "Continue a pipeline", + "description": { + "content": "Continue a pipeline from the setup phase. For information on using pipeline parameters with dynamic configuration, see the [Pipeline values and parameters](https://circleci.com/docs/pipeline-variables/#pipeline-parameters-and-dynamic-configuration) docs.", + "type": "text/plain" + }, + "url": { + "path": [ + "pipeline", + "continue" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"continuation-key\": \"\",\n \"configuration\": \"\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "0f960d94-ef52-4649-bf40-92727ea743b9", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + "continue" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"continuation-key\": \"\",\n \"configuration\": \"\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7e713e6-0111-4402-8f9a-86cd3c154681", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + "continue" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"continuation-key\": \"\",\n \"configuration\": \"\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "58b70929-0a0b-479f-a156-b75ea000ba06", + "name": "pipeline/{pipeline-id} - Get a pipeline by ID", + "request": { + "name": "Get a pipeline by ID", + "description": { + "content": "Returns a pipeline by the pipeline ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "pipeline", + ":pipeline-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "dc7bfb87-49fc-464a-b5b3-ff3a9519e7fb", + "name": "A pipeline object.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"1957-06-07T14:30:19.102Z\",\n \"errors\": [\n {\n \"type\": \"plan\",\n \"message\": \"string\"\n },\n {\n \"type\": \"trigger-rule\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"created\",\n \"trigger\": {\n \"type\": \"api\",\n \"received_at\": \"1959-11-28T20:15:38.541Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"2020-02-20T12:02:23.366Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3b349113-9f9a-491e-a649-3b3dc453e385", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ddc895f7-582a-4781-9df2-025f03a16c07", + "name": "pipeline/{pipeline-id} - Get a pipeline's configuration", + "request": { + "name": "Get a pipeline's configuration", + "description": { + "content": "Returns a pipeline's configuration by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "8f706375-c40d-4c56-a679-db593b6622f7", + "name": "The configuration strings for the pipeline.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"source\": \"string\",\n \"compiled\": \"string\",\n \"setup-config\": \"string\",\n \"compiled-setup-config\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74e26031-feba-4704-bae2-36368a375efd", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "029fddf6-e634-47ec-b2b1-1e2800945a64", + "name": "pipeline/{pipeline-id} - Get pipeline values for a pipeline", + "request": { + "name": "Get pipeline values for a pipeline", + "description": { + "content": "Returns a map of pipeline values by pipeline ID. For more information see the [pipeline values reference page](https://circleci.com/docs/variables/#pipeline-values).", + "type": "text/plain" + }, + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "values" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "5fcdfc9e-c82f-458a-8d06-f18f647411fd", + "name": "A JSON object of pipeline values", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "values" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1749e59-f0e5-435b-812a-db5e6dc018fc", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "values" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a735576c-ce5d-4d6b-a60e-e6985ab2cb29", + "name": "pipeline/{pipeline-id} - Get a pipeline's workflows", + "request": { + "name": "Get a pipeline's workflows", + "description": { + "content": "Returns a paginated list of workflows by pipeline ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "workflow" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "20d3f248-917f-404b-8022-dc622237940e", + "name": "A paginated list of workflow objects.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "workflow" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"ab5af322-df81-7de9-fc52-b3507f296730\",\n \"name\": \"build-and-test\",\n \"status\": \"running\",\n \"created_at\": \"1984-04-13T17:29:32.323Z\",\n \"stopped_at\": \"1998-04-18T17:44:11.891Z\",\n \"pipeline_id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"pipeline_number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"started_by\": \"fe43157f-b462-d672-001a-cebdcc1d14ec\",\n \"canceled_by\": \"962dc1a7-744f-a296-ae1a-4f899fd23e3b\",\n \"errored_by\": \"72864832-a83f-ef8b-5ff9-cb51b2a910e3\",\n \"tag\": \"setup\"\n },\n {\n \"id\": \"4f76dba1-45a5-1864-cf57-30f5313be40e\",\n \"name\": \"build-and-test\",\n \"status\": \"canceled\",\n \"created_at\": \"1999-07-13T04:16:38.900Z\",\n \"stopped_at\": \"1959-02-09T19:23:15.658Z\",\n \"pipeline_id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"pipeline_number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"started_by\": \"352a7d75-7030-0b6d-5a95-26b63811b509\",\n \"canceled_by\": \"ef6c5a6a-07cc-a533-e98f-f4251578e4c9\",\n \"errored_by\": \"0320b866-44f0-be07-67de-583ec354fa63\",\n \"tag\": \"setup\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "82fc3c1b-2b4e-4224-b993-a868bbc2e6d7", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "pipeline", + ":pipeline-id", + "workflow" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-id", + "description": "(Required) The unique ID of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "6cdb90ad-1ced-4b97-a2c8-b61de3d2e16c", + "name": "project", + "item": [ + { + "id": "96947a13-9186-48d5-8f4e-a865fe88d48b", + "name": "project/{project-slug} - Delete a project", + "request": { + "name": "Delete a project", + "description": { + "content": "Deletes a project by project slug", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "eb9b326b-0e5c-41c3-bcc2-1a6ac4ff4423", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ffba04d-96be-40b6-985b-7bfd91f7ca14", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "39b648d4-773f-4c53-bb39-d131e4c32cee", + "name": "project/{project-slug} - Get a project", + "request": { + "name": "Get a project", + "description": { + "content": "Retrieves a project by project slug.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "4c48f1d5-a42f-46b0-9fc8-8ceb46f954de", + "name": "A project object", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"name\": \"api-preview-docs\",\n \"id\": \"123656f3-8e25-7e40-b262-5d7cde425c84\",\n \"organization_name\": \"CircleCI-Public\",\n \"organization_slug\": \"gh/CircleCI-Public\",\n \"organization_id\": \"ec6887ec-7d44-4b31-b468-7e552408ee32\",\n \"vcs_info\": {\n \"vcs_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"provider\": \"CircleCI\",\n \"default_branch\": \"main\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "877de367-3ecb-4223-ae4c-e4da9d7f77f7", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c2044f7e-6ff5-4d3f-a959-a64246f8bbff", + "name": "checkout-key", + "item": [ + { + "id": "54aba916-3cce-4971-8aa4-b55461e8c3fb", + "name": "project/{project-slug}/checkout-key - Get all checkout keys", + "request": { + "name": "Get all checkout keys", + "description": { + "content": "Returns a sequence of checkout keys for `:project`.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "digest", + "value": "", + "description": "The fingerprint digest type to return. This may be either `md5` or `sha256`. If not passed, defaults to `md5`." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "552e5899-81c8-4365-866a-95e32c6f7867", + "name": "A sequence of checkout keys.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "digest", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"public-key\": \"ssh-rsa ...\",\n \"type\": \"deploy-key\",\n \"fingerprint\": \"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f\",\n \"preferred\": true,\n \"created-at\": \"2015-09-21T17:29:21.042Z\"\n },\n {\n \"public-key\": \"ssh-rsa ...\",\n \"type\": \"deploy-key\",\n \"fingerprint\": \"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f\",\n \"preferred\": true,\n \"created-at\": \"2015-09-21T17:29:21.042Z\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df11e74e-f64f-4417-bf0d-9e696471d5f6", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "digest", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "226b693d-219d-4190-88fa-6c2d724f8de8", + "name": "project/{project-slug}/checkout-key - Create a new checkout key", + "request": { + "name": "Create a new checkout key", + "description": { + "content": "Not available to projects that use GitLab or GitHub App. Creates a new checkout key. This API request is only usable with a user API token.\n Please ensure that you have authorized your account with GitHub before creating user keys.\n This is necessary to give CircleCI the permission to create a user key associated with\n your GitHub user account. You can find this page by visiting Project Settings > Checkout SSH Keys", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6641cf82-0b2d-4a9a-9a73-6569a8fd9bf8", + "name": "The checkout key.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"deploy-key\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"public-key\": \"ssh-rsa ...\",\n \"type\": \"deploy-key\",\n \"fingerprint\": \"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f\",\n \"preferred\": true,\n \"created-at\": \"2015-09-21T17:29:21.042Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7215619b-dc10-4a28-9ad8-f5693fdaffe3", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"deploy-key\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "68c192d9-7074-4fe5-ae68-139e240ed941", + "name": "project/{project-slug}/checkout-key/{fingerprint} - Get a checkout key", + "request": { + "name": "Get a checkout key", + "description": { + "content": "Returns an individual checkout key via md5 or sha256 fingerprint. sha256 keys should be url-encoded.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key", + ":fingerprint" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "fingerprint", + "description": "(Required) An SSH key fingerprint." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "136391d1-ae96-48d8-8060-1fcb1c0fdfe5", + "name": "The checkout key.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key", + ":fingerprint" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "fingerprint", + "description": "(Required) An SSH key fingerprint." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"public-key\": \"ssh-rsa ...\",\n \"type\": \"deploy-key\",\n \"fingerprint\": \"c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f\",\n \"preferred\": true,\n \"created-at\": \"2015-09-21T17:29:21.042Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f20f87b-3d71-4b9d-b110-bc80027117d8", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key", + ":fingerprint" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "fingerprint", + "description": "(Required) An SSH key fingerprint." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "66befeeb-c726-4a7e-9d38-c87f1b0ad5a5", + "name": "project/{project-slug}/checkout-key/{fingerprint} - Delete a checkout key", + "request": { + "name": "Delete a checkout key", + "description": { + "content": "Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys should be url-encoded.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key", + ":fingerprint" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "fingerprint", + "description": "(Required) An SSH key fingerprint." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "c0f910cb-eaf4-4ba9-b0b9-fc49ec60f59c", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key", + ":fingerprint" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "fingerprint", + "description": "(Required) An SSH key fingerprint." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6b0daf26-e28f-406c-9f24-80efbe1f8e68", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "checkout-key", + ":fingerprint" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "fingerprint", + "description": "(Required) An SSH key fingerprint." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "44a05b64-cc17-46a4-b9b8-4b9a4b46c176", + "name": "envvar", + "item": [ + { + "id": "752d5156-8b6a-4f0f-8ac9-8977e13152e0", + "name": "project/{project-slug}/envvar - List all environment variables", + "request": { + "name": "List all environment variables", + "description": { + "content": "Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "envvar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "6a6ba4df-0f6e-4156-92bb-f3fa19e1b4e4", + "name": "A sequence of environment variables.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"name\": \"foo\",\n \"value\": \"xxxx1234\",\n \"created-at\": {}\n },\n {\n \"name\": \"foo\",\n \"value\": \"xxxx1234\",\n \"created-at\": {}\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af077adc-1a21-43dd-ab22-22ba5420109a", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "61ea9eed-e3fa-4029-b718-320bf23b3149", + "name": "project/{project-slug}/envvar - Create an environment variable", + "request": { + "name": "Create an environment variable", + "description": { + "content": "Creates a new environment variable.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "envvar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"value\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7ff75569-5af1-4c24-be43-12bad0e409db", + "name": "The environment variable.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"foo\",\n \"value\": \"xxxx1234\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"foo\",\n \"value\": \"xxxx1234\",\n \"created-at\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac223414-7809-4f0f-ab72-c67510f03790", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"foo\",\n \"value\": \"xxxx1234\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f5a0d62a-4893-4993-9ea3-f69ca94984f3", + "name": "project/{project-slug}/envvar/{name} - Delete an environment variable", + "request": { + "name": "Delete an environment variable", + "description": { + "content": "Deletes the environment variable named :name.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "envvar", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "name", + "description": "(Required) The name of the environment variable." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "c677507b-e70f-4eae-889f-bb3687b5be4e", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "name", + "description": "(Required) The name of the environment variable." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c712e641-f004-4997-a322-48022a95f9bb", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "name", + "description": "(Required) The name of the environment variable." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5db10a11-aa26-4f84-b7b8-29f0c49bc4ab", + "name": "project/{project-slug}/envvar/{name} - Get a masked environment variable", + "request": { + "name": "Get a masked environment variable", + "description": { + "content": "Returns the masked value of environment variable :name.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "envvar", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "name", + "description": "(Required) The name of the environment variable." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "96eb9622-9334-4192-98d2-00ba8633ce7b", + "name": "The environment variable.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "name", + "description": "(Required) The name of the environment variable." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"foo\",\n \"value\": \"xxxx1234\",\n \"created-at\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "69859696-af41-4c76-accd-127554066a32", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "envvar", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "name", + "description": "(Required) The name of the environment variable." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "17fad696-b7be-4443-bb3b-6d9b6ba5d2a6", + "name": "job/{job-number}", + "item": [ + { + "id": "8e92c9d8-961a-44f3-be7d-3282d71304f8", + "name": "project/{project-slug}/job/{job-number} - Get job details", + "request": { + "name": "Get job details", + "description": { + "content": "Returns job details.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "job", + ":job-number" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "3773df8b-1532-4f27-83ae-55225c900016", + "name": "Job details.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "job", + ":job-number" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"number\": 1,\n \"name\": \"string\",\n \"status\": \"not_run\",\n \"started_at\": \"2002-03-29T12:32:55.249Z\",\n \"created_at\": \"2008-05-13T04:55:05.544Z\",\n \"queued_at\": \"1949-12-29T05:06:55.906Z\",\n \"duration\": 7008,\n \"executor\": {\n \"resource_class\": \"string\",\n \"type\": \"string\"\n },\n \"project\": {\n \"id\": \"fe917c26-7da0-6d47-50ec-9cc698ad410b\",\n \"slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"name\": \"api-preview-docs\",\n \"external_url\": \"https://github.com/CircleCI-Public/api-preview-docs\"\n },\n \"organization\": {\n \"name\": \"string\"\n },\n \"contexts\": [\n {\n \"name\": \"string\"\n },\n {\n \"name\": \"string\"\n }\n ],\n \"web_url\": \"string\",\n \"parallel_runs\": [\n {\n \"index\": 6466,\n \"status\": \"string\"\n },\n {\n \"index\": 822,\n \"status\": \"string\"\n }\n ],\n \"latest_workflow\": {\n \"id\": \"96b8c6d4-3c8b-09c7-4778-ab61fa82ecde\",\n \"name\": \"build-and-test\"\n },\n \"pipeline\": {\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\"\n },\n \"parallelism\": 6253,\n \"messages\": [\n {\n \"type\": \"string\",\n \"message\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"type\": \"string\",\n \"message\": \"string\",\n \"reason\": \"string\"\n }\n ],\n \"stopped_at\": \"1992-09-24T22:19:55.281Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51a50562-8067-402d-b719-f9deb0105347", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "job", + ":job-number" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "db7d617f-1f61-4702-906c-c07a243bc067", + "name": "project/{project-slug}/job/{job-number} - Cancel job by job number", + "request": { + "name": "Cancel job by job number", + "description": { + "content": "Cancel job with a given job number.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "job", + ":job-number", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null + }, + "response": [ + { + "id": "cfd84e51-9117-455d-b75a-ea525befcb06", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "job", + ":job-number", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e365913-3706-4aa5-8087-8161a4530e31", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "job", + ":job-number", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "64329476-927f-44fe-9977-f1779c6569e8", + "name": "pipeline", + "item": [ + { + "id": "972fd329-ef9e-4baf-9091-00948fbc8f30", + "name": "project/{project-slug}/pipeline - Get all pipelines", + "request": { + "name": "Get all pipelines", + "description": { + "content": "Returns all pipelines for this project.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "branch", + "value": "", + "description": "The name of a vcs branch." + }, + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "58ebfda1-3702-4427-9bbd-10b9d67750a6", + "name": "A sequence of pipelines.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "branch", + "value": "" + }, + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"2003-09-04T11:16:44.251Z\",\n \"errors\": [\n {\n \"type\": \"other\",\n \"message\": \"string\"\n },\n {\n \"type\": \"invalid-trigger-setup\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"setup\",\n \"trigger\": {\n \"type\": \"api\",\n \"received_at\": \"1976-12-02T08:19:06.483Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"2024-09-02T17:17:17.727Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n },\n {\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"1947-09-07T21:23:33.927Z\",\n \"errors\": [\n {\n \"type\": \"invalid-trigger-setup\",\n \"message\": \"string\"\n },\n {\n \"type\": \"permission\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"setup-pending\",\n \"trigger\": {\n \"type\": \"webhook\",\n \"received_at\": \"1950-07-22T02:28:17.203Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"1981-12-21T17:44:48.956Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ccb7ba98-7300-4c60-83e3-39ecac962538", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "branch", + "value": "" + }, + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "71655050-c34d-444e-98f8-823eade76da0", + "name": "project/{project-slug}/pipeline - Trigger a new pipeline", + "request": { + "name": "Trigger a new pipeline", + "description": { + "content": "**[This endpoint is superseded by the [new Trigger Pipeline API](#tag/Pipeline/operation/triggerPipelineRun), which supports all organization and pipeline types except GitLab.]** Triggers a new pipeline on the project. Does not support triggering pipelines integrated with GitLab or GitHub App.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"branch\": \"\",\n \"tag\": \"\",\n \"parameters\": {\n \"key_0\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1b76c923-c331-4643-8521-f61406598d3b", + "name": "The created pipeline.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"branch\": \"feature/design-new-api\",\n \"tag\": \"v3.1.4159\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"state\": \"created\",\n \"number\": 25,\n \"created_at\": \"2008-02-05T15:06:55.910Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eeaf602e-95bc-4e8d-a2f4-e22896b23fd0", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"branch\": \"feature/design-new-api\",\n \"tag\": \"v3.1.4159\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9a6938c2-2384-4c8b-8f55-8845fc007f80", + "name": "project/{project-slug}/pipeline - Get your pipelines", + "request": { + "name": "Get your pipelines", + "description": { + "content": "Returns a sequence of all pipelines for this project triggered by the user.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "pipeline", + "mine" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "8d7030fa-18e0-474c-b1d0-0f8070b23a8c", + "name": "A sequence of pipelines.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline", + "mine" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"2003-09-04T11:16:44.251Z\",\n \"errors\": [\n {\n \"type\": \"other\",\n \"message\": \"string\"\n },\n {\n \"type\": \"invalid-trigger-setup\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"setup\",\n \"trigger\": {\n \"type\": \"api\",\n \"received_at\": \"1976-12-02T08:19:06.483Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"2024-09-02T17:17:17.727Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n },\n {\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"1947-09-07T21:23:33.927Z\",\n \"errors\": [\n {\n \"type\": \"invalid-trigger-setup\",\n \"message\": \"string\"\n },\n {\n \"type\": \"permission\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"setup-pending\",\n \"trigger\": {\n \"type\": \"webhook\",\n \"received_at\": \"1950-07-22T02:28:17.203Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"1981-12-21T17:44:48.956Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "60283a90-dc06-431d-a7b3-e311208b1ca8", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline", + "mine" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0009a24b-9163-409b-80aa-d59761bf7408", + "name": "project/{project-slug}/pipeline - Get a pipeline by pipeline number", + "request": { + "name": "Get a pipeline by pipeline number", + "description": { + "content": "Returns a pipeline by the pipeline number.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "pipeline", + ":pipeline-number" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-number", + "description": "(Required) The number of the pipeline." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "20e1dae8-ef11-4b63-915e-c4c1705e64fc", + "name": "A pipeline object.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline", + ":pipeline-number" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-number", + "description": "(Required) The number of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"created_at\": \"1957-06-07T14:30:19.102Z\",\n \"errors\": [\n {\n \"type\": \"plan\",\n \"message\": \"string\"\n },\n {\n \"type\": \"trigger-rule\",\n \"message\": \"string\"\n }\n ],\n \"state\": \"created\",\n \"trigger\": {\n \"type\": \"api\",\n \"received_at\": \"1959-11-28T20:15:38.541Z\",\n \"actor\": {\n \"login\": \"string\",\n \"avatar_url\": \"string\"\n }\n },\n \"updated_at\": \"2020-02-20T12:02:23.366Z\",\n \"trigger_parameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"vcs\": {\n \"provider_name\": \"GitHub\",\n \"origin_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"target_repository_url\": \"https://github.com/CircleCI-Public/api-preview-docs\",\n \"revision\": \"f454a02b5d10fcccfd7d9dd7608a76d6493a98b4\",\n \"branch\": \"feature/design-new-api\",\n \"review_id\": \"123\",\n \"review_url\": \"https://github.com/CircleCI-Public/api-preview-docs/pull/123\",\n \"tag\": \"v3.1.4159\",\n \"commit\": {\n \"subject\": \"string\",\n \"body\": \"string\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da5e3a79-1d29-47bd-ae3a-974387e45d60", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "pipeline", + ":pipeline-number" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline-number", + "description": "(Required) The number of the pipeline." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "16a683e2-076a-4e2d-a9b6-6b2c1293c54d", + "name": "schedule", + "item": [ + { + "id": "c7f873f9-397d-424a-80b3-9b07dc7ee995", + "name": "project/{project-slug}/schedule - Create a schedule", + "request": { + "name": "Create a schedule", + "description": { + "content": "Not yet available to projects that use GitLab or GitHub App. Creates a schedule and returns the created schedule.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"timetable\": {\n \"per-hour\": \"\",\n \"hours-of-day\": [\n \"\",\n \"\"\n ],\n \"days-of-week\": [\n \"\",\n \"\"\n ],\n \"days-of-month\": [\n \"\",\n \"\"\n ],\n \"months\": [\n \"\",\n \"\"\n ]\n },\n \"attribution-actor\": \"\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"description\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "333e14e9-2df2-46bb-ab25-8891f0912882", + "name": "A schedule object.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"timetable\": {\n \"per-hour\": \"\",\n \"hours-of-day\": [\n \"\",\n \"\"\n ],\n \"days-of-week\": [\n \"\",\n \"\"\n ],\n \"days-of-month\": [\n \"\",\n \"\"\n ],\n \"months\": [\n \"\",\n \"\"\n ]\n },\n \"attribution-actor\": \"current\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"description\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"3919cdf9-90ed-745e-c526-e7978bea7d26\",\n \"name\": \"string\",\n \"timetable\": {\n \"per-hour\": 8468,\n \"hours-of-day\": [\n 537,\n 2908\n ],\n \"days-of-week\": [\n \"THU\",\n \"TUE\"\n ],\n \"days-of-month\": [\n 3468,\n 5047\n ],\n \"months\": [\n \"AUG\",\n \"DEC\"\n ]\n },\n \"description\": \"string\",\n \"project-slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"actor\": {\n \"id\": \"3e1dfbf5-b459-2af6-1727-838fb01f9a9e\",\n \"login\": \"string\",\n \"name\": \"string\"\n },\n \"created-at\": \"2001-03-04T21:32:23.396Z\",\n \"updated-at\": \"1986-12-27T06:36:59.695Z\",\n \"parameters\": {\n \"key_0\": 2423\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3546e87-400b-4272-870e-61d00b0ed354", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"timetable\": {\n \"per-hour\": \"\",\n \"hours-of-day\": [\n \"\",\n \"\"\n ],\n \"days-of-week\": [\n \"\",\n \"\"\n ],\n \"days-of-month\": [\n \"\",\n \"\"\n ],\n \"months\": [\n \"\",\n \"\"\n ]\n },\n \"attribution-actor\": \"current\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"description\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1994be4c-e7b3-43d5-913f-d505f21f91c9", + "name": "project/{project-slug}/schedule - Get all schedules", + "request": { + "name": "Get all schedules", + "description": { + "content": "Returns all schedules for this project.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "page-token", + "value": "", + "description": "A token to retrieve the next page of results." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "44b1ad19-55fd-44f4-8681-ddc10b6ba5c0", + "name": "A sequence of schedules.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"494cba23-2e3c-2d78-3382-6a8872ebb40e\",\n \"name\": \"string\",\n \"timetable\": {\n \"per-hour\": 8021,\n \"hours-of-day\": [\n 138,\n 9899\n ],\n \"days-of-week\": [\n \"THU\",\n \"MON\"\n ],\n \"days-of-month\": [\n 9185,\n 1376\n ],\n \"months\": [\n \"JUN\",\n \"APR\"\n ]\n },\n \"description\": \"string\",\n \"project-slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"actor\": {\n \"id\": \"263e6fb8-451e-1823-d88f-13ce67a1d534\",\n \"login\": \"string\",\n \"name\": \"string\"\n },\n \"created-at\": \"1960-06-29T10:46:05.809Z\",\n \"updated-at\": \"2005-06-27T13:40:26.225Z\",\n \"parameters\": {\n \"key_0\": 4388,\n \"key_1\": 8345\n }\n },\n {\n \"id\": \"2bc30065-e278-81d9-6276-3c8fbc684da8\",\n \"name\": \"string\",\n \"timetable\": {\n \"per-hour\": 2438,\n \"hours-of-day\": [\n 233,\n 1571\n ],\n \"days-of-week\": [\n \"SAT\",\n \"SAT\"\n ],\n \"days-of-month\": [\n 5815,\n 4317\n ],\n \"months\": [\n \"JUL\",\n \"APR\"\n ]\n },\n \"description\": \"string\",\n \"project-slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"actor\": {\n \"id\": \"553db807-9bb5-fd4f-cf2f-e16ec85cc30f\",\n \"login\": \"string\",\n \"name\": \"string\"\n },\n \"created-at\": \"1948-12-26T07:21:22.395Z\",\n \"updated-at\": \"1977-03-25T17:09:22.972Z\",\n \"parameters\": {\n \"key_0\": 5794,\n \"key_1\": 3037,\n \"key_2\": 3199,\n \"key_3\": 9920\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1148b350-16c1-43ec-9a71-78a69186febf", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "page-token", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "1c6eaf57-bab8-465a-8829-723302b01119", + "name": "project/{project-slug}/{job-number} - Get a job's artifacts", + "request": { + "name": "Get a job's artifacts", + "description": { + "content": "Returns a job's artifacts.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + ":job-number", + "artifacts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "f62be952-1938-4c81-815e-5b02fc11b338", + "name": "A paginated list of the job's artifacts.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + ":job-number", + "artifacts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"path\": \"string\",\n \"node_index\": 269,\n \"url\": \"string\"\n },\n {\n \"path\": \"string\",\n \"node_index\": 5847,\n \"url\": \"string\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "91a41f0e-fd4f-4912-a006-6e355f4cc825", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + ":job-number", + "artifacts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "cd568b58-7da9-475c-99b7-8587d1eb830d", + "name": "project/{project-slug}/{job-number} - Get test metadata", + "request": { + "name": "Get test metadata", + "description": { + "content": "Get test metadata for a build. In the rare case where there is more than 250MB of test data on the job, no results will be returned.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":project-slug", + ":job-number", + "tests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "abe88ab8-59a4-4899-89cd-fa683d19b2b0", + "name": "A paginated list of test results.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + ":job-number", + "tests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"message\": \"\",\n \"source\": \"\",\n \"run_time\": 1000.6187861066574,\n \"file\": \"\",\n \"result\": \"\",\n \"name\": \"\",\n \"classname\": \"\"\n },\n {\n \"message\": \"\",\n \"source\": \"\",\n \"run_time\": 1083.8850638896558,\n \"file\": \"\",\n \"result\": \"\",\n \"name\": \"\",\n \"classname\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "64b17831-3b21-49dd-8b0e-c87217348198", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":project-slug", + ":job-number", + "tests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "job-number", + "description": "(Required) The number of the job." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project-slug", + "description": "(Required) Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a5228687-fbcd-48af-83cf-56ee54210005", + "name": "{provider}/{organization}/{project}", + "item": [ + { + "id": "3b609cb3-3acc-4bac-9083-197ca7f5c020", + "name": "project/{provider}/{organization}/{project} - ️ Create a project", + "request": { + "name": "️ Create a project", + "description": { + "content": "__[DEPRECATED] This endpoint is replaced by [organization/{org-slug-or-id}/project](https://circleci.com/docs/api/v2/index.html#tag/Project/operation/createProject) and documentation will be removed on August 1st, 2025.__ Creates a new CircleCI project, and returns a list of the default advanced settings. Can only be called on a repo with a main branch and an existing config.yml file. Not yet available to projects that use GitLab or GitHub App.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null + }, + "response": [ + { + "id": "d57d369b-a24b-4541-8381-e723b4300d43", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_fork_prs\": true,\n \"build_prs_only\": true,\n \"disable_ssh\": true,\n \"forks_receive_secret_env_vars\": true,\n \"oss\": true,\n \"set_github_status\": false,\n \"setup_workflows\": false,\n \"write_settings_requires_admin\": true,\n \"pr_only_branch_overrides\": [\n \"string\",\n \"string\"\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "feec2be6-8f10-4a50-8a2c-ccff9ed5b01a", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63c07a25-523c-4a45-adf2-e0be21e67e21", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7967bdf-a70e-4533-b65b-45b3de3a0a8c", + "name": "None or insufficient credentials provided.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Permission denied.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb1fe560-42a8-4b63-a599-0d132735141f", + "name": "Either a branch or a project were not found.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Branch not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "64259240-5496-4072-acd1-d7007f3b2e66", + "name": "Create projects using the API is currently supported for classic Github OAuth and Bitbucket projects only.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Method Not Allowed", + "code": 405, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Create projects using the API is currently supported for classic Github OAuth and Bitbucket projects only.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be60a608-3fd9-4909-8cfe-63db0e3d3660", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1f50ea50-5493-461b-8a8e-636170dfc06f", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "eab3b036-84d0-46c0-8164-0d994ddbde40", + "name": "settings", + "item": [ + { + "id": "54518a3e-9612-4b68-a760-602268a20fb6", + "name": "project/{provider}/{organization}/{project}/settings - Get project settings", + "request": { + "name": "Get project settings", + "description": { + "content": "[__EXPERIMENTAL__] Returns a list of the advanced settings for a CircleCI project, whether enabled (true) or not (false).", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "5f9a9c14-cc04-4559-84b8-eac4067f8537", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_fork_prs\": true,\n \"build_prs_only\": false,\n \"disable_ssh\": true,\n \"forks_receive_secret_env_vars\": false,\n \"oss\": false,\n \"set_github_status\": false,\n \"setup_workflows\": false,\n \"write_settings_requires_admin\": false,\n \"pr_only_branch_overrides\": [\n \"string\",\n \"string\"\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81a22fa0-f5aa-40b6-b9c0-ec223fa79674", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30d3b6c8-c6d7-42d6-85a3-9cd6f67b81fb", + "name": "None or insufficient credentials provided.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Permission denied.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e658b21-2a16-4bd2-91d1-facaed70b595", + "name": "Insufficient credentials for a private project, OR the organization, project, or repository does not exist.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Project not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65d7c1f2-23e2-46db-a8ea-dc0fdbef9464", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "264e3c8a-0344-4b6a-9eea-69b254559ebc", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f3b3ea48-5a2a-48c8-b051-a4f033a4c749", + "name": "project/{provider}/{organization}/{project}/settings - Update project settings", + "request": { + "name": "Update project settings", + "description": { + "content": "[__EXPERIMENTAL__] Updates one or more of the advanced settings for a CircleCI project.", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": \"\",\n \"build_fork_prs\": \"\",\n \"build_prs_only\": \"\",\n \"disable_ssh\": \"\",\n \"forks_receive_secret_env_vars\": \"\",\n \"oss\": \"\",\n \"set_github_status\": \"\",\n \"setup_workflows\": \"\",\n \"write_settings_requires_admin\": \"\",\n \"pr_only_branch_overrides\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "9aadb9ca-a6c0-4721-827a-6f05a32d9f44", + "name": "Successful response. Always includes the full advanced settings object. Returned even when the provided updates match the existing settings, but can also be returned when `oss: true` fails to set.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_prs_only\": true,\n \"pr_only_branch_overrides\": [\n \"main\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"advanced\": {\n \"autocancel_builds\": \"\",\n \"build_fork_prs\": \"\",\n \"build_prs_only\": \"\",\n \"disable_ssh\": \"\",\n \"forks_receive_secret_env_vars\": \"\",\n \"oss\": \"\",\n \"set_github_status\": \"\",\n \"setup_workflows\": \"\",\n \"write_settings_requires_admin\": \"\",\n \"pr_only_branch_overrides\": [\n \"\",\n \"\"\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9898a5e-914a-43ab-b4f1-1c7591f83e23", + "name": "Request is malformed, e.g. with improperly encoded JSON", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_prs_only\": true,\n \"pr_only_branch_overrides\": [\n \"main\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid JSON body.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf8b6514-dae4-4f39-8ae4-9a2f6c3e7330", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_prs_only\": true,\n \"pr_only_branch_overrides\": [\n \"main\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd51a451-65f1-436a-9021-0b77f29f6c3b", + "name": "None or insufficient credentials provided.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_prs_only\": true,\n \"pr_only_branch_overrides\": [\n \"main\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Permission denied.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6acffe7-5987-4215-9b22-3ac00e284d50", + "name": "Insufficient credentials for a private project, OR the organization, project, or repository does not exist.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_prs_only\": true,\n \"pr_only_branch_overrides\": [\n \"main\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Project not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "affff3bd-eb83-44a0-9e36-ff712cfc949b", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_prs_only\": true,\n \"pr_only_branch_overrides\": [\n \"main\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "72ed5b78-7272-4753-b254-27540d262c63", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced\": {\n \"autocancel_builds\": false,\n \"build_prs_only\": true,\n \"pr_only_branch_overrides\": [\n \"main\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "e6013cfe-f62d-4b41-9693-84de958e317f", + "name": "project/{provider}/{organization}/{project} - [Recommended] Trigger a new pipeline", + "request": { + "name": "[Recommended] Trigger a new pipeline", + "description": { + "content": "Trigger a pipeline given a pipeline definition ID. Supports all integrations except GitLab.\n\nThe slash-separated project slug is shown in Project Settings > Overview.\n\nDepending on the organization type, the project slug may have a human-readable format (`vcs_type/org_name/project_name`)\nor be an opaque string (e.g. `circleci/43G3lM5RtfFE7v5sa4nWAU/44n9wujWcTnVZ2b5S8Fnat`).", + "type": "text/plain" + }, + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "pipeline", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"definition_id\": \"\",\n \"config\": {\n \"branch\": \"\",\n \"tag\": \"\"\n },\n \"checkout\": {\n \"branch\": \"\",\n \"tag\": \"\"\n },\n \"parameters\": {\n \"key_0\": false,\n \"key_1\": 7812.0160661707905\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "78ea9584-c22f-45f6-8059-1a6f5ed0f130", + "name": "Successful response with no created pipeline.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "pipeline", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"definition_id\": \"2338d0ae-5541-4bbf-88a2-55e9f7281f80\",\n \"config\": {\n \"branch\": \"main\"\n },\n \"checkout\": {\n \"tag\": \"v2\"\n },\n \"parameters\": {\n \"example_param\": \"my value\",\n \"example_param2\": true,\n \"example_param3\": 3\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Ignoring pipeline due to CI skip in the commit\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b9c1114c-8789-41f6-8fe7-cab929e0a313", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "pipeline", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"definition_id\": \"2338d0ae-5541-4bbf-88a2-55e9f7281f80\",\n \"config\": {\n \"branch\": \"main\"\n },\n \"checkout\": {\n \"tag\": \"v2\"\n },\n \"parameters\": {\n \"example_param\": \"my value\",\n \"example_param2\": true,\n \"example_param3\": 3\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"state\": \"created\",\n \"created_at\": \"1994-02-11T18:32:20.243Z\",\n \"number\": 25,\n \"id\": \"c236af8f-09c2-67e6-ef68-aa80d80c892c\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d3d380c-7486-4505-83b2-ebbe8087c527", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "pipeline", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"definition_id\": \"2338d0ae-5541-4bbf-88a2-55e9f7281f80\",\n \"config\": {\n \"branch\": \"main\"\n },\n \"checkout\": {\n \"tag\": \"v2\"\n },\n \"parameters\": {\n \"example_param\": \"my value\",\n \"example_param2\": true,\n \"example_param3\": 3\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b703b104-c65c-41f7-8dc0-5d6fee0eeece", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "pipeline", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"definition_id\": \"2338d0ae-5541-4bbf-88a2-55e9f7281f80\",\n \"config\": {\n \"branch\": \"main\"\n },\n \"checkout\": {\n \"tag\": \"v2\"\n },\n \"parameters\": {\n \"example_param\": \"my value\",\n \"example_param2\": true,\n \"example_param3\": 3\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f93fd8cf-d7b3-4075-a104-a7a792e6e4cc", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "project", + ":provider", + ":organization", + ":project", + "pipeline", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "provider", + "description": "(Required) The first segment of the slash-separated project slug, as shown in Project Settings > Overview." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "organization", + "description": "(Required) The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "project", + "description": "(Required) The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"definition_id\": \"2338d0ae-5541-4bbf-88a2-55e9f7281f80\",\n \"config\": {\n \"branch\": \"main\"\n },\n \"checkout\": {\n \"tag\": \"v2\"\n },\n \"parameters\": {\n \"example_param\": \"my value\",\n \"example_param2\": true,\n \"example_param3\": 3\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [] + }, + { + "id": "f9cc83bb-b455-43a3-b3ec-4cf1ad9a7a00", + "name": "schedule/{schedule-id}", + "item": [ + { + "id": "0ea4591d-c6d5-4db2-9853-d5b42ba31cc0", + "name": "schedule/{schedule-id} - Update a schedule", + "request": { + "name": "Update a schedule", + "description": { + "content": "Not yet available to projects that use GitLab or GitHub App. Updates a schedule and returns the updated schedule.", + "type": "text/plain" + }, + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"\",\n \"name\": \"\",\n \"timetable\": {\n \"per-hour\": \"\",\n \"hours-of-day\": [\n \"\",\n \"\"\n ],\n \"days-of-week\": [\n \"\",\n \"\"\n ],\n \"days-of-month\": [\n \"\",\n \"\"\n ],\n \"months\": [\n \"\",\n \"\"\n ]\n },\n \"attribution-actor\": \"\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1a78cf3f-b5e2-4a1d-b189-ba646d753cff", + "name": "A schedule object.", + "originalRequest": { + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"\",\n \"name\": \"\",\n \"timetable\": {\n \"per-hour\": \"\",\n \"hours-of-day\": [\n \"\",\n \"\"\n ],\n \"days-of-week\": [\n \"\",\n \"\"\n ],\n \"days-of-month\": [\n \"\",\n \"\"\n ],\n \"months\": [\n \"\",\n \"\"\n ]\n },\n \"attribution-actor\": \"current\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"3919cdf9-90ed-745e-c526-e7978bea7d26\",\n \"name\": \"string\",\n \"timetable\": {\n \"per-hour\": 8468,\n \"hours-of-day\": [\n 537,\n 2908\n ],\n \"days-of-week\": [\n \"THU\",\n \"TUE\"\n ],\n \"days-of-month\": [\n 3468,\n 5047\n ],\n \"months\": [\n \"AUG\",\n \"DEC\"\n ]\n },\n \"description\": \"string\",\n \"project-slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"actor\": {\n \"id\": \"3e1dfbf5-b459-2af6-1727-838fb01f9a9e\",\n \"login\": \"string\",\n \"name\": \"string\"\n },\n \"created-at\": \"2001-03-04T21:32:23.396Z\",\n \"updated-at\": \"1986-12-27T06:36:59.695Z\",\n \"parameters\": {\n \"key_0\": 2423\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d06f1f81-b8ba-4d79-97ca-cde7755bb939", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"\",\n \"name\": \"\",\n \"timetable\": {\n \"per-hour\": \"\",\n \"hours-of-day\": [\n \"\",\n \"\"\n ],\n \"days-of-week\": [\n \"\",\n \"\"\n ],\n \"days-of-month\": [\n \"\",\n \"\"\n ],\n \"months\": [\n \"\",\n \"\"\n ]\n },\n \"attribution-actor\": \"current\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "38a8f7d0-37b0-4c36-b62b-9e03a3c05aaf", + "name": "schedule/{schedule-id} - Delete a schedule", + "request": { + "name": "Delete a schedule", + "description": { + "content": "Not yet available to projects that use GitLab or GitHub App. Deletes the schedule by id.", + "type": "text/plain" + }, + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "d0ba5d1b-42d8-4c41-bd3f-f9dbc1cf80b6", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b6dcbf1-520a-44fd-9fa1-2b430997b5de", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "78b79f57-7e43-4086-866d-ac325bf6c874", + "name": "schedule/{schedule-id} - Get a schedule", + "request": { + "name": "Get a schedule", + "description": { + "content": "Get a schedule by id.", + "type": "text/plain" + }, + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "66cf712c-87bc-49d2-8364-20e80b60f349", + "name": "A schedule object.", + "originalRequest": { + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"3919cdf9-90ed-745e-c526-e7978bea7d26\",\n \"name\": \"string\",\n \"timetable\": {\n \"per-hour\": 8468,\n \"hours-of-day\": [\n 537,\n 2908\n ],\n \"days-of-week\": [\n \"THU\",\n \"TUE\"\n ],\n \"days-of-month\": [\n 3468,\n 5047\n ],\n \"months\": [\n \"AUG\",\n \"DEC\"\n ]\n },\n \"description\": \"string\",\n \"project-slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"actor\": {\n \"id\": \"3e1dfbf5-b459-2af6-1727-838fb01f9a9e\",\n \"login\": \"string\",\n \"name\": \"string\"\n },\n \"created-at\": \"2001-03-04T21:32:23.396Z\",\n \"updated-at\": \"1986-12-27T06:36:59.695Z\",\n \"parameters\": {\n \"key_0\": 2423\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cfe823a0-a21b-4749-83e2-4a6883a18fbb", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "schedule", + ":schedule-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "schedule-id", + "description": "(Required) The unique ID of the schedule." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "bf5ffd50-b376-4248-8eeb-d3ac5fff0a1d", + "name": "User Information", + "request": { + "name": "User Information", + "description": { + "content": "Provides information about the user with the given ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "user", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the user." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "37247081-ce88-4e90-ab16-89e012fd0560", + "name": "User login information.", + "originalRequest": { + "url": { + "path": [ + "user", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the user." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"72aaab65-2206-57dc-8690-7df99bc9b3b8\",\n \"login\": \"string\",\n \"name\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34f3578c-a1dc-422b-a536-424919dc3dac", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "user", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the user." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e8c6c699-c66e-41d9-870d-dfdb697f14c1", + "name": "webhook", + "item": [ + { + "id": "a25f1304-a222-42a8-9f4f-9b778feed168", + "name": "webhook - Create an outbound webhook", + "request": { + "name": "Create an outbound webhook", + "description": { + "content": "Creates an outbound webhook.", + "type": "text/plain" + }, + "url": { + "path": [ + "webhook" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"verify-tls\": \"\",\n \"signing-secret\": \"\",\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "96273e56-1875-45ec-b840-3bae89e6957d", + "name": "A webhook", + "originalRequest": { + "url": { + "path": [ + "webhook" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"verify-tls\": \"\",\n \"signing-secret\": \"\",\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"77bfeb99-1a62-6f21-bf67-d2cf61ab85a2\",\n \"scope\": {\n \"id\": \"8d2a1ee4-fea3-2fcb-9fb9-65f740f0a861\",\n \"type\": \"string\"\n },\n \"name\": \"string\",\n \"events\": [\n \"job-completed\",\n \"job-completed\"\n ],\n \"url\": \"string\",\n \"verify-tls\": true,\n \"signing-secret\": \"string\",\n \"created-at\": \"2015-09-21T17:29:21.042Z\",\n \"updated-at\": \"2015-09-21T17:29:21.042Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32b36872-1978-42ff-b283-ca84e8e8568a", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "webhook" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"verify-tls\": \"\",\n \"signing-secret\": \"\",\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8a36a8f9-9740-477b-8f79-551c990c641e", + "name": "webhook - List webhooks", + "request": { + "name": "List webhooks", + "description": { + "content": "Get a list of outbound webhooks that match the given scope-type and scope-id", + "type": "text/plain" + }, + "url": { + "path": [ + "webhook" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "scope-id", + "value": "", + "description": "(Required) ID of the scope being used (at the moment, only project ID is supported)" + }, + { + "disabled": false, + "key": "scope-type", + "value": "", + "description": "(Required) Type of the scope being used" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "980e201b-1812-4852-b31a-647cbe9464ad", + "name": "A list of webhooks", + "originalRequest": { + "url": { + "path": [ + "webhook" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "scope-id", + "value": "" + }, + { + "key": "scope-type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"ab70792d-af9b-61f4-e794-f92d750c1364\",\n \"scope\": {\n \"id\": \"b6e9462d-0007-4215-813c-d3c6d3c3a3cf\",\n \"type\": \"string\"\n },\n \"name\": \"string\",\n \"events\": [\n \"job-completed\",\n \"workflow-completed\"\n ],\n \"url\": \"string\",\n \"verify-tls\": true,\n \"signing-secret\": \"string\",\n \"created-at\": \"2015-09-21T17:29:21.042Z\",\n \"updated-at\": \"2015-09-21T17:29:21.042Z\"\n },\n {\n \"id\": \"5fac5b29-f95f-710d-0f69-f9476699212b\",\n \"scope\": {\n \"id\": \"7921d6f0-99d6-9b92-2919-e2b46e0be53d\",\n \"type\": \"string\"\n },\n \"name\": \"string\",\n \"events\": [\n \"workflow-completed\",\n \"job-completed\"\n ],\n \"url\": \"string\",\n \"verify-tls\": true,\n \"signing-secret\": \"string\",\n \"created-at\": \"2015-09-21T17:29:21.042Z\",\n \"updated-at\": \"2015-09-21T17:29:21.042Z\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfa7ff17-faa0-4bbf-aaab-eeabf26f1ab4", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "webhook" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "scope-id", + "value": "" + }, + { + "key": "scope-type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c0981f9e-3efd-41c9-a077-085219917648", + "name": "webhook/{webhook-id} - Get a webhook", + "request": { + "name": "Get a webhook", + "description": { + "content": "Get an outbound webhook by id.", + "type": "text/plain" + }, + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "c1d1db31-8f3a-47fd-b031-df8ab7ce6def", + "name": "A webhook", + "originalRequest": { + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"77bfeb99-1a62-6f21-bf67-d2cf61ab85a2\",\n \"scope\": {\n \"id\": \"8d2a1ee4-fea3-2fcb-9fb9-65f740f0a861\",\n \"type\": \"string\"\n },\n \"name\": \"string\",\n \"events\": [\n \"job-completed\",\n \"job-completed\"\n ],\n \"url\": \"string\",\n \"verify-tls\": true,\n \"signing-secret\": \"string\",\n \"created-at\": \"2015-09-21T17:29:21.042Z\",\n \"updated-at\": \"2015-09-21T17:29:21.042Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b7f9fbc3-8b2a-4b31-9bca-eaf6d0ae5d8a", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8eb31ac2-a061-4448-b177-d9ed51b65c6f", + "name": "webhook/{webhook-id} - Delete an outbound webhook", + "request": { + "name": "Delete an outbound webhook", + "description": { + "content": "Deletes an outbound webhook", + "type": "text/plain" + }, + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "8db99689-408a-4628-bdd0-985d292a25bc", + "name": "A confirmation message", + "originalRequest": { + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "feabeb10-b468-4991-a5ab-b2ed878bf660", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "49fb4723-de4a-4482-a08a-114e152dd968", + "name": "webhook/{webhook-id} - Update an outbound webhook", + "request": { + "name": "Update an outbound webhook", + "description": { + "content": "Updates an outbound webhook.", + "type": "text/plain" + }, + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "fb47b67a-58ea-4be2-8870-4c72ffe61596", + "name": "A webhook", + "originalRequest": { + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"77bfeb99-1a62-6f21-bf67-d2cf61ab85a2\",\n \"scope\": {\n \"id\": \"8d2a1ee4-fea3-2fcb-9fb9-65f740f0a861\",\n \"type\": \"string\"\n },\n \"name\": \"string\",\n \"events\": [\n \"job-completed\",\n \"job-completed\"\n ],\n \"url\": \"string\",\n \"verify-tls\": true,\n \"signing-secret\": \"string\",\n \"created-at\": \"2015-09-21T17:29:21.042Z\",\n \"updated-at\": \"2015-09-21T17:29:21.042Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8500e0cb-9bf0-43b9-ac7a-9680d3b1e4e2", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "webhook", + ":webhook-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "webhook-id", + "description": "(Required) ID of the webhook (UUID)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "c15b6d71-e502-49c5-b809-bace472e5e6a", + "name": "workflow/{id}", + "item": [ + { + "id": "23daac5b-3bb3-4db5-ae0f-63d358dc129c", + "name": "workflow/{id} - Get a workflow", + "request": { + "name": "Get a workflow", + "description": { + "content": "Returns summary fields of a workflow by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "25bb446a-4c00-4851-a99b-9619a3997b5c", + "name": "A workflow object.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"6838861c-d019-a36e-7d4e-8a8e3b870fc3\",\n \"name\": \"build-and-test\",\n \"status\": \"unauthorized\",\n \"created_at\": \"1989-11-22T06:55:50.071Z\",\n \"stopped_at\": \"2016-12-22T10:58:37.972Z\",\n \"pipeline_id\": \"5034460f-c7c4-4c43-9457-de07e2029e7b\",\n \"pipeline_number\": 25,\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"started_by\": \"01f1b049-31c4-5de4-512e-096471231d0c\",\n \"canceled_by\": \"43a61d3f-024c-020e-c7ed-ada8acae4f12\",\n \"errored_by\": \"dd2ec594-946c-9a47-1a98-fd9befb7752b\",\n \"tag\": \"setup\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96f8f0f0-5045-49c8-a18e-33b54a22364f", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2ca0ad53-e395-4a66-94a3-3b0621bdecc6", + "name": "workflow/{id} - Approve a job", + "request": { + "name": "Approve a job", + "description": { + "content": "Approves a pending approval job in a workflow.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow", + ":id", + "approve", + ":approval_request_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "approval_request_id", + "description": "(Required) The ID of the job being approved." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null + }, + "response": [ + { + "id": "d827adef-6259-4287-a087-0a75fd2a9b42", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "approve", + ":approval_request_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "approval_request_id", + "description": "(Required) The ID of the job being approved." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f370cda9-948b-4ddf-bcc6-f058d0a4c265", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "approve", + ":approval_request_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "approval_request_id", + "description": "(Required) The ID of the job being approved." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "597fc670-7214-4dd0-84f4-79bf484dbc5d", + "name": "workflow/{id} - Cancel a workflow", + "request": { + "name": "Cancel a workflow", + "description": { + "content": "Cancels a running workflow.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null + }, + "response": [ + { + "id": "91493fba-b31c-4411-b31d-8ba87111f0b3", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "001ceb98-f2ce-4f75-aadb-1d6f48760a04", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "bb180bb5-c767-435e-8644-346f23ad0790", + "name": "workflow/{id} - Get a workflow's jobs", + "request": { + "name": "Get a workflow's jobs", + "description": { + "content": "Returns a sequence of jobs for a workflow.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow", + ":id", + "job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "62377190-4119-4693-9b1d-c7d32be88970", + "name": "A paginated sequence of jobs.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"f3bdc113-3244-c872-5b1f-e651455b4b25\",\n \"name\": \"string\",\n \"started_at\": \"1976-10-24T07:56:55.844Z\",\n \"dependencies\": [\n \"4f71d684-e028-48d9-c93b-ef9fa3c3784e\",\n \"2102ae93-12e0-26d3-8204-2e7e5ef12fe8\"\n ],\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"status\": \"running\",\n \"type\": \"approval\",\n \"canceled_by\": \"adaf766f-de5d-1efc-d1a4-fb6245191bf7\",\n \"job_number\": 1,\n \"approved_by\": \"3e63e600-3956-b71a-11dc-87d911794e10\",\n \"requires\": {\n \"key_0\": [\n \"failed\",\n \"success\"\n ],\n \"key_1\": [\n \"canceled\",\n \"canceled\"\n ],\n \"key_2\": [\n \"failed\",\n \"success\"\n ]\n },\n \"stopped_at\": \"2015-10-01T07:28:11.675Z\",\n \"approval_request_id\": \"3629ac63-8aab-77a7-564b-254710146bbe\"\n },\n {\n \"id\": \"6fa3e211-1562-281c-c308-b0d1739ba9a3\",\n \"name\": \"string\",\n \"started_at\": \"2003-07-12T12:45:18.783Z\",\n \"dependencies\": [\n \"aef1e499-ac09-567b-a28e-1cef79f48cf3\",\n \"e61f892f-58ec-ea6f-6be2-3ea41be30e01\"\n ],\n \"project_slug\": \"gh/CircleCI-Public/api-preview-docs\",\n \"status\": \"canceled\",\n \"type\": \"approval\",\n \"canceled_by\": \"eb9dddcd-b23f-b51b-46b4-e71a68a00e8b\",\n \"job_number\": 1,\n \"approved_by\": \"ed4d1420-1eca-b961-39b2-98ff4a641899\",\n \"requires\": {\n \"key_0\": [\n \"failed\",\n \"failed\"\n ]\n },\n \"stopped_at\": \"2014-12-15T08:11:21.067Z\",\n \"approval_request_id\": \"9bbadb96-107b-17d1-fc8c-13f7d8e41849\"\n }\n ],\n \"next_page_token\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c7098390-bb94-465b-815f-7082293504db", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "cb16e491-3edb-4483-af2a-9e60b17868e0", + "name": "workflow/{id} - Rerun a workflow", + "request": { + "name": "Rerun a workflow", + "description": { + "content": "Reruns a workflow.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow", + ":id", + "rerun" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"enable_ssh\": \"\",\n \"from_failed\": \"\",\n \"jobs\": [\n \"\",\n \"\"\n ],\n \"sparse_tree\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "23b9fbaf-37bf-4b16-a1d6-6af10ba284be", + "name": "A confirmation message.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "rerun" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"enable_ssh\": false,\n \"from_failed\": false,\n \"jobs\": [\n \"c65b68ef-e73b-4bf2-be9a-7a322a9df150\",\n \"5e957edd-5e8c-4985-9178-5d0d69561822\"\n ],\n \"sparse_tree\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_id\": \"0e53027b-521a-4c40-9042-47e72b3c63a3\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "449ed775-068d-4065-a47e-8eaade0dc8bb", + "name": "Error response.", + "originalRequest": { + "url": { + "path": [ + "workflow", + ":id", + "rerun" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "id", + "description": "(Required) The unique ID of the workflow." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"enable_ssh\": false,\n \"from_failed\": false,\n \"jobs\": [\n \"c65b68ef-e73b-4bf2-be9a-7a322a9df150\",\n \"5e957edd-5e8c-4985-9178-5d0d69561822\"\n ],\n \"sparse_tree\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "66a53156-5d51-4191-990a-a1a1f27253fc", + "name": "org/{orgID}", + "item": [ + { + "id": "313de3ba-c4c4-4d2a-b061-f3df79f4f10b", + "name": "oidc-custom-claims", + "item": [ + { + "id": "7136a4d7-c19b-4389-95c1-6c95e689bdc8", + "name": "org/{orgID}/oidc-custom-claims - Delete org-level claims", + "request": { + "name": "Delete org-level claims", + "description": { + "content": "Deletes org-level custom claims of OIDC identity tokens", + "type": "text/plain" + }, + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "claims", + "value": "", + "description": "(Required) comma separated list of claims to delete. Valid values are \"audience\" and \"ttl\"." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "9f8d959f-6354-4d33-93ba-72ea7ebad644", + "name": "Claims successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": \"194fafed-9a0a-1d7c-e53e-372a46388495\",\n \"audience\": [\n \"string\",\n \"string\"\n ],\n \"audience_updated_at\": \"2025-08-02T13:11:50.412Z\",\n \"project_id\": \"b71ce10d-a60c-ead7-86b6-76ef49a81af2\",\n \"ttl\": \"2682h76826390s660955ms1ms210367737ms672ms89h\",\n \"ttl_updated_at\": \"2000-03-14T08:38:18.222Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2dcf079b-eb5a-46f9-a1e0-29a0ad7eb2ba", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3b5e4144-763a-4765-bfd4-3a73008bd265", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9fc232be-4273-4b08-936b-74463f686480", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"internal server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "71cff0aa-6817-4373-aeb1-35380b37d412", + "name": "org/{orgID}/oidc-custom-claims - Get org-level claims", + "request": { + "name": "Get org-level claims", + "description": { + "content": "Fetches org-level custom claims of OIDC identity tokens", + "type": "text/plain" + }, + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "0c003349-72a9-42a0-b8cf-3d5e8eb1b3bb", + "name": "Claims successfully fetched.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": \"0c4f4a44-71d8-2d5a-5c77-d26652cc9551\",\n \"audience\": [\n \"string\",\n \"string\"\n ],\n \"audience_updated_at\": \"1977-01-26T01:20:49.183Z\",\n \"project_id\": \"6716e973-f70f-ff2b-01f5-469949465ccf\",\n \"ttl\": \"08879517253s953621d66282347256s199921d2710858s\",\n \"ttl_updated_at\": \"2012-06-10T16:28:35.756Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "585d2f87-cfa6-4c7a-99ae-bdf1e047fe5d", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4bed06d-7875-41ea-9ef0-667f6cb61792", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f0229d8-d259-43bc-a99e-90069f04f4bb", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"internal server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1190b211-d2f2-4935-91c1-53d35ff1b2ad", + "name": "org/{orgID}/oidc-custom-claims - Patch org-level claims", + "request": { + "name": "Patch org-level claims", + "description": { + "content": "Creates/Updates org-level custom claims of OIDC identity tokens", + "type": "text/plain" + }, + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2c789be9-d8e2-4ea9-8fd6-e76a667acf62", + "name": "Claims successfully patched.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": \"62cb5a70-bea2-6677-cb86-d5fad8631370\",\n \"audience\": [\n \"string\",\n \"string\"\n ],\n \"audience_updated_at\": \"1972-11-16T19:08:04.638Z\",\n \"project_id\": \"354db8bd-0fa5-15dd-c322-f52be1c8d16c\",\n \"ttl\": \"\",\n \"ttl_updated_at\": \"1965-06-20T02:56:53.267Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3cd6935-c067-4ca4-ad9e-4e2dcfdd2cbb", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d758635b-7285-4e4f-a025-5685e65308b3", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6d36905-ad69-4e1f-af89-c1262008c20b", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"internal server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "fe8a12b7-a8ca-41c2-a742-13cc65b2e7aa", + "name": "project/{projectID}/oidc-custom-claims", + "item": [ + { + "id": "309b3cf6-5d45-4a36-960d-e91e45b3fcfc", + "name": "org/{orgID}/project/{projectID}/oidc-custom-claims - Delete project-level claims", + "request": { + "name": "Delete project-level claims", + "description": { + "content": "Deletes project-level custom claims of OIDC identity tokens", + "type": "text/plain" + }, + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "claims", + "value": "", + "description": "(Required) comma separated list of claims to delete. Valid values are \"audience\" and \"ttl\"." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "6c64d003-8573-4663-83e9-2c435107dd61", + "name": "Claims successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": \"62cb5a70-bea2-6677-cb86-d5fad8631370\",\n \"audience\": [\n \"string\",\n \"string\"\n ],\n \"audience_updated_at\": \"1972-11-16T19:08:04.638Z\",\n \"project_id\": \"354db8bd-0fa5-15dd-c322-f52be1c8d16c\",\n \"ttl\": \"\",\n \"ttl_updated_at\": \"1965-06-20T02:56:53.267Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33749585-98e4-42df-8e2d-5ecad2cc5780", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb417cd4-cfc0-4ce5-821b-ea91ce3858da", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5319bcde-e31b-48f0-9e76-ef2878e10aad", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "claims", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"internal server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "734ed2a3-5c33-4703-b395-9ad72999ab8e", + "name": "org/{orgID}/project/{projectID}/oidc-custom-claims - Get project-level claims", + "request": { + "name": "Get project-level claims", + "description": { + "content": "Fetches project-level custom claims of OIDC identity tokens", + "type": "text/plain" + }, + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "154b6d5b-fa72-431c-a944-3f6fc6d3373d", + "name": "Claims successfully fetched.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": \"62cb5a70-bea2-6677-cb86-d5fad8631370\",\n \"audience\": [\n \"string\",\n \"string\"\n ],\n \"audience_updated_at\": \"1972-11-16T19:08:04.638Z\",\n \"project_id\": \"354db8bd-0fa5-15dd-c322-f52be1c8d16c\",\n \"ttl\": \"\",\n \"ttl_updated_at\": \"1965-06-20T02:56:53.267Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6020e07d-abae-4f85-ae63-173d787a1edc", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae5ab451-17ae-46a6-bdce-c07aa3d019f8", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12e54d9e-e761-4258-bd75-b28272c5dc51", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"internal server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "707c2d08-3abb-4eac-b333-f5e83e978f1e", + "name": "org/{orgID}/project/{projectID}/oidc-custom-claims - Patch project-level claims", + "request": { + "name": "Patch project-level claims", + "description": { + "content": "Creates/Updates project-level custom claims of OIDC identity tokens", + "type": "text/plain" + }, + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "98444a98-b9d6-45e5-b433-5d06ae22858b", + "name": "Claims successfully patched.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"org_id\": \"62cb5a70-bea2-6677-cb86-d5fad8631370\",\n \"audience\": [\n \"string\",\n \"string\"\n ],\n \"audience_updated_at\": \"1972-11-16T19:08:04.638Z\",\n \"project_id\": \"354db8bd-0fa5-15dd-c322-f52be1c8d16c\",\n \"ttl\": \"\",\n \"ttl_updated_at\": \"1965-06-20T02:56:53.267Z\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd16d0d8-a0cd-412a-b5df-3da40aadb46d", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d9295463-b68f-404f-a6b4-6d430b3dd5a5", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ee6a555-1c46-4176-9817-332c9aec19ea", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "org", + ":orgID", + "project", + ":projectID", + "oidc-custom-claims" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "orgID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "projectID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"audience\": [\n \"\",\n \"\"\n ],\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"internal server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [] + }, + { + "id": "da7a873d-209a-4cd8-af97-5cde26148086", + "name": "owner/{ownerID}/context/{context}", + "item": [ + { + "id": "1e2f081b-45e7-49ad-af1a-de799ab6b917", + "name": "decision", + "item": [ + { + "id": "da4e9270-6cc2-4ce8-95b1-8a41aa29e039", + "name": "owner/{ownerID}/context/{context}/decision - Retrieves the owner's decision audit logs.", + "request": { + "name": "Retrieves the owner's decision audit logs.", + "description": { + "content": "This endpoint will return a list of decision audit logs that were made using this owner's policies.", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "status", + "value": "", + "description": "Return decisions matching this decision status." + }, + { + "disabled": false, + "key": "after", + "value": "", + "description": "Return decisions made after this date." + }, + { + "disabled": false, + "key": "before", + "value": "", + "description": "Return decisions made before this date." + }, + { + "disabled": false, + "key": "branch", + "value": "", + "description": "Return decisions made on this branch." + }, + { + "disabled": false, + "key": "project_id", + "value": "", + "description": "Return decisions made for this project." + }, + { + "disabled": false, + "key": "build_number", + "value": "", + "description": "Return decisions made for this build number." + }, + { + "disabled": false, + "key": "offset", + "value": "", + "description": "Sets the offset when retrieving the decisions, for paging." + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "535fb3aa-bd20-44a3-a410-01ba1882c0c5", + "name": "Decision logs successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "status", + "value": "" + }, + { + "key": "after", + "value": "" + }, + { + "key": "before", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "project_id", + "value": "" + }, + { + "key": "build_number", + "value": "" + }, + { + "key": "offset", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"created_at\": \"2020-12-07T00:22:57.157Z\",\n \"decision\": {\n \"status\": \"string\",\n \"enabled_rules\": [\n \"string\",\n \"string\"\n ],\n \"hard_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ],\n \"reason\": \"string\",\n \"soft_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ]\n },\n \"id\": \"705645f6-13f7-a791-3d74-e8780442ed71\",\n \"metadata\": {\n \"build_number\": 5908,\n \"project_id\": \"02713683-d3e7-059e-a212-94064d4fa306\",\n \"ssh_rerun\": false,\n \"vcs\": {\n \"branch\": \"string\",\n \"origin_repository_url\": \"string\",\n \"release_tag\": \"string\",\n \"target_repository_url\": \"string\"\n }\n },\n \"policies\": {\n \"policy_name1\": \"1f40fc92da241694750979ee6cf582f2d5d7d28e18335de05abc54d0560e0f5302860c652bf08d560252aa5e74210546f369fbbbce8c12cfc7957b2652fe9a75\",\n \"policy_name2\": \"5267768822ee624d48fce15ec5ca79cbd602cb7f4c2157a516556991f22ef8c7b5ef7b18d1ff41c59370efb0858651d44a936c11b7b144c48fe04df3c6a3e8da\"\n },\n \"time_taken_ms\": 3073\n },\n {\n \"created_at\": \"1964-06-14T18:36:40.302Z\",\n \"decision\": {\n \"status\": \"string\",\n \"enabled_rules\": [\n \"string\",\n \"string\"\n ],\n \"hard_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ],\n \"reason\": \"string\",\n \"soft_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ]\n },\n \"id\": \"46b518c7-7604-592c-786e-8a3603aed4b2\",\n \"metadata\": {\n \"build_number\": 8363,\n \"project_id\": \"da167746-32ee-ddc0-e8e2-cff90cac5e1d\",\n \"ssh_rerun\": true,\n \"vcs\": {\n \"branch\": \"string\",\n \"origin_repository_url\": \"string\",\n \"release_tag\": \"string\",\n \"target_repository_url\": \"string\"\n }\n },\n \"policies\": {\n \"policy_name1\": \"1f40fc92da241694750979ee6cf582f2d5d7d28e18335de05abc54d0560e0f5302860c652bf08d560252aa5e74210546f369fbbbce8c12cfc7957b2652fe9a75\",\n \"policy_name2\": \"5267768822ee624d48fce15ec5ca79cbd602cb7f4c2157a516556991f22ef8c7b5ef7b18d1ff41c59370efb0858651d44a936c11b7b144c48fe04df3c6a3e8da\"\n },\n \"time_taken_ms\": 128\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "37434b3c-016e-4b8c-84fd-b7f91eb51535", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "status", + "value": "" + }, + { + "key": "after", + "value": "" + }, + { + "key": "before", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "project_id", + "value": "" + }, + { + "key": "build_number", + "value": "" + }, + { + "key": "offset", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7f7e1d6e-d225-44f7-89f3-47aa398f3fcd", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "status", + "value": "" + }, + { + "key": "after", + "value": "" + }, + { + "key": "before", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "project_id", + "value": "" + }, + { + "key": "build_number", + "value": "" + }, + { + "key": "offset", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e3b80bb-22b9-4f65-b284-8d2753f56549", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "status", + "value": "" + }, + { + "key": "after", + "value": "" + }, + { + "key": "before", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "project_id", + "value": "" + }, + { + "key": "build_number", + "value": "" + }, + { + "key": "offset", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a9da99f-3376-412d-8d14-ce6e75290ce1", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "status", + "value": "" + }, + { + "key": "after", + "value": "" + }, + { + "key": "before", + "value": "" + }, + { + "key": "branch", + "value": "" + }, + { + "key": "project_id", + "value": "" + }, + { + "key": "build_number", + "value": "" + }, + { + "key": "offset", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0a4f4f4d-8da5-49d5-99df-fef51b7745ef", + "name": "owner/{ownerID}/context/{context}/decision - Makes a decision", + "request": { + "name": "Makes a decision", + "description": { + "content": "This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision.", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"input\": \"\",\n \"metadata\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2300d33c-9b47-4689-94d0-94d48835c96f", + "name": "Decision rendered by applying the policy against the provided data. Response will be modeled by the data and rego processed.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": \"\",\n \"metadata\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"status\": \"string\",\n \"enabled_rules\": [\n \"string\",\n \"string\"\n ],\n \"hard_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ],\n \"reason\": \"string\",\n \"soft_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2db0370c-a7c7-4c9c-9d1b-15c3a1f79ba3", + "name": "The request is malformed", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": \"\",\n \"metadata\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"context: must be a valid value.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "005264ce-655a-4fd8-a037-32d5c153c931", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": \"\",\n \"metadata\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "55bceb4f-841c-4201-95e4-3c1934e5aef1", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": \"\",\n \"metadata\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"There was an error processing your request.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f4525c3f-7960-4ef2-aee8-4580eedc75c1", + "name": "settings", + "item": [ + { + "id": "a4c9e809-9cdb-4d05-bccb-4905cfcc9adf", + "name": "owner/{ownerID}/context/{context}/decision/settings - Get the decision settings", + "request": { + "name": "Get the decision settings", + "description": { + "content": "This endpoint retrieves the current decision settings (eg enable/disable policy evaluation)", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "ff197e6f-83e2-4528-89f0-9995590ebab9", + "name": "Decision settings successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"enabled\": true\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d678375-d4e2-4953-b007-68635a4f1762", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca13ab1d-5541-4496-a71c-1a0a3dbc88a9", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11b2fd10-6874-4eba-b2d3-81eaa05d9b05", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "628a5d42-18f8-4c91-b006-e4335d296f39", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e5d9f611-1985-4709-8c8e-1861586075e8", + "name": "owner/{ownerID}/context/{context}/decision/settings - Set the decision settings", + "request": { + "name": "Set the decision settings", + "description": { + "content": "This endpoint allows modifying decision settings (eg enable/disable policy evaluation)", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "318cd480-bcba-411b-b8a1-a6b407aa67b1", + "name": "Decision settings successfully set.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"enabled\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a3f9200-0d35-4d3b-a5f7-7d11178f7e74", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5fe10c41-357c-470f-aa59-061fe87cba21", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59cd6e87-0e82-4296-9270-1fa528b504f6", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85e41fdb-a522-4b6a-b3f9-f213e3a3dd3a", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + "settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "6c69e738-fb78-4c2c-ab59-bbec461576a0", + "name": "owner/{ownerID}/context/{context}/decision/{decisionID} - Retrieves the owner's decision audit log by given decisionID", + "request": { + "name": "Retrieves the owner's decision audit log by given decisionID", + "description": { + "content": "This endpoint will retrieve a decision for a given decision log ID", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "df568c39-c038-4281-b087-5ca4f4959567", + "name": "Decision log successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created_at\": \"2010-11-28T08:37:30.265Z\",\n \"decision\": {\n \"status\": \"string\",\n \"enabled_rules\": [\n \"string\",\n \"string\"\n ],\n \"hard_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ],\n \"reason\": \"string\",\n \"soft_failures\": [\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n },\n {\n \"rule\": \"string\",\n \"reason\": \"string\"\n }\n ]\n },\n \"id\": \"192d1b27-4a62-bd88-c52e-9c3b3d1247de\",\n \"metadata\": {\n \"build_number\": 5536,\n \"project_id\": \"d1cc628d-4dbb-cb87-b2b8-e37030c75341\",\n \"ssh_rerun\": false,\n \"vcs\": {\n \"branch\": \"string\",\n \"origin_repository_url\": \"string\",\n \"release_tag\": \"string\",\n \"target_repository_url\": \"string\"\n }\n },\n \"policies\": {\n \"policy_name1\": \"1f40fc92da241694750979ee6cf582f2d5d7d28e18335de05abc54d0560e0f5302860c652bf08d560252aa5e74210546f369fbbbce8c12cfc7957b2652fe9a75\",\n \"policy_name2\": \"5267768822ee624d48fce15ec5ca79cbd602cb7f4c2157a516556991f22ef8c7b5ef7b18d1ff41c59370efb0858651d44a936c11b7b144c48fe04df3c6a3e8da\"\n },\n \"time_taken_ms\": 4642\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7979596f-d12d-4c4e-ae97-2ce8a482d63d", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4735fb3b-9b20-48e5-8b7f-0a0643558919", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "026ca2d9-605c-4942-bce9-ad7e180be45d", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c693dd0-7d2f-4e39-8932-8635faa9b80c", + "name": "There was no decision log found for given decision_id, and owner_id.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"decision log not found\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed32ed12-543f-4380-aa15-dcc968755fd8", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "96af1129-31cd-448b-ae8b-aedd0b733914", + "name": "owner/{ownerID}/context/{context}/decision/{decisionID} - Retrieves Policy Bundle for a given decision log ID", + "request": { + "name": "Retrieves Policy Bundle for a given decision log ID", + "description": { + "content": "This endpoint will retrieve a policy bundle for a given decision log ID", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "ae1e91bb-25f3-46f4-924c-26f425c99112", + "name": "Policy-Bundle retrieved successfully for given decision log ID", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"key_0\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ae6fb5a-bf76-409d-a25f-e02b5de09afd", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f502494f-1d45-4f9c-9b31-075b66f0f35d", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51cc3852-3222-431b-80d2-d56880da6bc6", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f54da95-605c-4b89-987c-c28136e0a863", + "name": "There was no decision log found for given decision_id, and owner_id.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"decision log not found\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1bd38d1-90be-46da-bea5-b032c6973237", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "decision", + ":decisionID", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "decisionID", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "fa337e06-82ac-4f41-97bb-7024c0ef1f94", + "name": "policy-bundle", + "item": [ + { + "id": "0e2de1a9-84ce-4c06-b2be-03dbb79390da", + "name": "owner/{ownerID}/context/{context}/policy-bundle - Retrieves Policy Bundle", + "request": { + "name": "Retrieves Policy Bundle", + "description": { + "content": "This endpoint will retrieve a policy bundle", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "04dbca99-389d-449b-b11d-c97feb54e00b", + "name": "Policy-Bundle retrieved successfully.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"key_0\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3c34eb29-eecd-4683-805c-15b879bbc048", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e237367a-5fc0-4613-bddd-d145da159aaf", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "27914a90-a74c-47da-a961-6731df220655", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cad907f-58d8-4bd0-b4d5-085ed6af7f2f", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8c4e490c-6a38-460d-90eb-ec601e128f14", + "name": "owner/{ownerID}/context/{context}/policy-bundle - Creates policy bundle for the context", + "request": { + "name": "Creates policy bundle for the context", + "description": { + "content": "This endpoint replaces the current policy bundle with the provided policy bundle", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a41a7bfe-36bf-433c-bc56-4aa7c5714865", + "name": "Policy-Bundle diff successfully returned.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": [\n \"string\",\n \"string\"\n ],\n \"deleted\": [\n \"string\",\n \"string\"\n ],\n \"modified\": [\n \"string\",\n \"string\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9aa1bc90-c98d-4060-8d87-6e53b74d6e6f", + "name": "Policy-Bundle successfully created.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": [\n \"string\",\n \"string\"\n ],\n \"deleted\": [\n \"string\",\n \"string\"\n ],\n \"modified\": [\n \"string\",\n \"string\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d354769-f330-40b5-a1ca-74b688a514b7", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9adf4e4f-c157-4ede-918b-b9482f3d5453", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e53fedcb-5c2e-4949-9891-d022c0029dca", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c098e78e-c48b-47e6-b61d-e2c73ec13c2d", + "name": "The request exceeds the maximum payload size for policy bundles ~2.5Mib", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Request Entity Too Large", + "code": 413, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"http: request payload too large\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2fa6b112-cff2-42b3-868f-b10d9d0f28ca", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "key": "dry", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"policies\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8436d540-e60d-41b3-bbb4-631432ef150f", + "name": "owner/{ownerID}/context/{context}/policy-bundle - Retrieves a policy document", + "request": { + "name": "Retrieves a policy document", + "description": { + "content": "This endpoint will retrieve a policy document.", + "type": "text/plain" + }, + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle", + ":policyName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "policyName", + "description": "(Required) the policy name set by the rego policy_name rule" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "45401e47-d1a1-4011-a1e8-43cb6f9b0666", + "name": "Policy retrieved successfully.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle", + ":policyName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "policyName", + "description": "(Required) the policy name set by the rego policy_name rule" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"content\": \"string\",\n \"created_at\": \"1984-09-03T18:13:06.817Z\",\n \"created_by\": \"string\",\n \"name\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6cc26a79-7ca0-4df5-96cd-3a1190be4dd9", + "name": "The request is malformed (e.g, a given path parameter is invalid)", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle", + ":policyName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "policyName", + "description": "(Required) the policy name set by the rego policy_name rule" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"OwnerID: must be a valid UUID.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3904fb2b-3477-4185-8c8f-e50d6bb2313f", + "name": "The request is unauthorized", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle", + ":policyName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "policyName", + "description": "(Required) the policy name set by the rego policy_name rule" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Unauthorized\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41e4053b-a796-440f-acf4-a37830b1a933", + "name": "The user is forbidden from making this request", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle", + ":policyName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "policyName", + "description": "(Required) the policy name set by the rego policy_name rule" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"Forbidden\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc84681c-059a-4b07-869b-125babaa98c9", + "name": "There was no policy that was found with the given owner_id and policy name.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle", + ":policyName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "policyName", + "description": "(Required) the policy name set by the rego policy_name rule" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"policy not found\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bab2aeb1-a98b-4d5a-81f4-8b5bd9b9ef5c", + "name": "Something unexpected happened on the server.", + "originalRequest": { + "url": { + "path": [ + "owner", + ":ownerID", + "context", + ":context", + "policy-bundle", + ":policyName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "ownerID", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "context", + "description": "(Required)" + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "policyName", + "description": "(Required) the policy name set by the rego policy_name rule" + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"unexpected server error\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [] + }, + { + "id": "447bdf63-cb87-42cd-ac9d-b913b4b33f22", + "name": "organizations/{org_id}/usage_export_job", + "item": [ + { + "id": "74690554-59f5-4021-a988-07b9384c1226", + "name": "organizations/{org_id}/usage_export_job - Create a usage export", + "request": { + "name": "Create a usage export", + "description": { + "content": "Submits a request to create a usage export for an organization.", + "type": "text/plain" + }, + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"start\": \"\",\n \"end\": \"\",\n \"shared_org_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e39c7da4-819f-467f-a6fe-53e1ccaf76fe", + "name": "Usage export created successfully", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"start\": \"\",\n \"end\": \"\",\n \"shared_org_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"usage_export_job_id\": \"d7364aee-02f9-3d88-1ef4-999b9afbebd7\",\n \"state\": \"created\",\n \"start\": \"1960-11-15T09:53:26.547Z\",\n \"end\": \"1976-05-20T20:02:01.078Z\",\n \"download_urls\": [\n \"http://VMLJYJy.mozcg.uCcyjdyll7JMGzrUBk7l8Oi3,A,N6h0D+KD\",\n \"https://qAjETGklWrWnjxnFCThgtGSgjjJMfLnD.gzioB,+FCueSsclVRHkCT\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0e5621c-079a-43d1-8bbb-305cf619f37f", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"start\": \"\",\n \"end\": \"\",\n \"shared_org_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "934206fd-13de-4699-ae96-8c69fbe1eeb1", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"start\": \"\",\n \"end\": \"\",\n \"shared_org_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "643a4045-20c0-4f80-85d2-bc079abab116", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"start\": \"\",\n \"end\": \"\",\n \"shared_org_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e870321-24a4-4a9c-80ad-08b30e6b1871", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"start\": \"\",\n \"end\": \"\",\n \"shared_org_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2299e8a-9e02-4b4c-87eb-0f2f2d4eca98", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"start\": \"\",\n \"end\": \"\",\n \"shared_org_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5e581d3c-57d3-4099-b449-7009acf9e8a3", + "name": "organizations/{org_id}/usage_export_job - Get a usage export", + "request": { + "name": "Get a usage export", + "description": { + "content": "Gets a usage export for an organization.", + "type": "text/plain" + }, + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job", + ":usage_export_job_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "usage_export_job_id", + "description": "(Required) An opaque identifier of a usage export job." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "302369f8-6bd1-481e-bc33-2882f243c851", + "name": "Usage export fetched successfully", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job", + ":usage_export_job_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "usage_export_job_id", + "description": "(Required) An opaque identifier of a usage export job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"usage_export_job_id\": \"5c1d8459-e5c9-2f6c-4db1-a020d9833c5d\",\n \"state\": \"failed\",\n \"download_urls\": [\n \"http://eROnwEIHIg.dxmL1AL,QlOI5s1fMMWWS,NFGRnxDe\",\n \"https://admUiTPUkpaxfs.iupoYRLA2OJOO1ZKjTZkkW5Z2An+HLWoiLOW5v+GmdYEorhtB-4r7pe\"\n ],\n \"error_reason\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "93de5373-b023-4627-9def-2fdbc8a2a857", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job", + ":usage_export_job_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "usage_export_job_id", + "description": "(Required) An opaque identifier of a usage export job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "616df034-35c4-4835-b7e6-ddfd8f73c49b", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job", + ":usage_export_job_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "usage_export_job_id", + "description": "(Required) An opaque identifier of a usage export job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "15af79e7-571c-4457-ada3-5744976cfc46", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job", + ":usage_export_job_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "usage_export_job_id", + "description": "(Required) An opaque identifier of a usage export job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16b479bf-ff81-4c43-8bf6-436fc2a800e4", + "name": "API rate limits exceeded.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job", + ":usage_export_job_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "usage_export_job_id", + "description": "(Required) An opaque identifier of a usage export job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Rate limit exceeded.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2efbec1-0d6c-47b9-93d7-c759bbc24f22", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "organizations", + ":org_id", + "usage_export_job", + ":usage_export_job_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "org_id", + "description": "(Required) An opaque identifier of an organization." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "usage_export_job_id", + "description": "(Required) An opaque identifier of a usage export job." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "96c092c8-109a-4fb5-a790-0a4c3d661a90", + "name": "projects/{project_id}", + "item": [ + { + "id": "5a6e4297-8cf5-4a3c-a823-8bbffe5994a5", + "name": "pipeline-definitions", + "item": [ + { + "id": "c2fb7370-b221-4745-9124-2f3b0904cf5f", + "name": "projects/{project_id}/pipeline-definitions - List pipeline definitions", + "request": { + "name": "List pipeline definitions", + "description": { + "content": "List all pipeline definitions for a given project. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "0f0e28c8-0683-4eaa-a812-c51551bbe062", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"f009e333-1123-5567-caa4-80b27967abaf\",\n \"name\": \"some pipeline\",\n \"description\": \"some pipeline description\",\n \"created_at\": \"2002-11-29T17:42:50.256Z\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n }\n }\n },\n {\n \"id\": \"7554b6dc-778c-bb79-7d5f-d3ba9fd9cda7\",\n \"name\": \"some pipeline\",\n \"description\": \"some pipeline description\",\n \"created_at\": \"1968-01-12T05:48:35.025Z\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d582392-31e5-411d-bbce-11407741e4ef", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c7418c62-2281-4335-9ba9-3615c976f4ed", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e3bab1f-6a60-4554-96f5-e39661d6363d", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "19f145c8-1443-470c-aab8-6eea2fc6e482", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f8b9bdb6-7abe-436d-b90c-ea32f2c840d7", + "name": "projects/{project_id}/pipeline-definitions - Create pipeline definition", + "request": { + "name": "Create pipeline definition", + "description": { + "content": "Create a pipeline definition for a given project. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"config_source\": {\n \"provider\": \"\",\n \"repo\": {\n \"external_id\": \"\"\n },\n \"file_path\": \"\"\n },\n \"checkout_source\": {\n \"provider\": \"\",\n \"repo\": {\n \"external_id\": \"\"\n }\n },\n \"description\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "27fa95f2-3b3f-4579-8443-f3215dcb9e91", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n },\n \"description\": \"Some pipeline description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"832c9378-5873-25e4-45f9-fcc5744e6307\",\n \"name\": \"some pipeline\",\n \"description\": \"some pipeline description\",\n \"created_at\": \"2011-05-12T06:38:58.492Z\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9474b88e-3231-471c-a485-8275513865b8", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n },\n \"description\": \"Some pipeline description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0e1fac2-be26-42fe-a172-48c08a952451", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n },\n \"description\": \"Some pipeline description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb2bb97c-e754-46d1-a839-186292329210", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n },\n \"description\": \"Some pipeline description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b45d086-be2e-4766-a82d-f1e1d4938ff7", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n },\n \"description\": \"Some pipeline description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2fc472b0-9e7f-46d3-9184-16890bcc953f", + "name": "projects/{project_id}/pipeline-definitions/{pipeline_definition_id} - Get pipeline definition", + "request": { + "name": "Get pipeline definition", + "description": { + "content": "Get details for a pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app` or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "840ad223-8c19-4999-b555-8dbd7d972109", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"832c9378-5873-25e4-45f9-fcc5744e6307\",\n \"name\": \"some pipeline\",\n \"description\": \"some pipeline description\",\n \"created_at\": \"2011-05-12T06:38:58.492Z\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e104a7a-f0f7-438c-b450-7b6a95e236fc", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7fe1402-f01a-4ca0-a2f4-5e045fec5c6e", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c649f72d-6848-46b3-b8e0-d8335f5a6c9e", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30621694-db48-4b5f-97e5-405480d16f53", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "86eec14d-b44f-444e-9b77-fa913b2c6a47", + "name": "projects/{project_id}/pipeline-definitions/{pipeline_definition_id} - Update pipeline definition", + "request": { + "name": "Update pipeline definition", + "description": { + "content": "Update pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app` or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"config_source\": {\n \"file_path\": \"\"\n },\n \"checkout_source\": {\n \"provider\": \"\",\n \"repo\": {\n \"external_id\": \"\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8bb2720f-9912-49af-8c9b-70b034383d3e", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"description\": \"Some pipeline description\",\n \"config_source\": {\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"832c9378-5873-25e4-45f9-fcc5744e6307\",\n \"name\": \"some pipeline\",\n \"description\": \"some pipeline description\",\n \"created_at\": \"2011-05-12T06:38:58.492Z\",\n \"config_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01c072f7-9895-4855-9663-bc7c83032f27", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"description\": \"Some pipeline description\",\n \"config_source\": {\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3de37c5-f09d-4bf1-a24e-81a262243dc2", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"description\": \"Some pipeline description\",\n \"config_source\": {\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "030f044b-4e2c-40de-accf-4472619297d5", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"description\": \"Some pipeline description\",\n \"config_source\": {\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "937a8e45-08b0-4a45-b6f1-da638f926104", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Some pipeline name\",\n \"description\": \"Some pipeline description\",\n \"config_source\": {\n \"file_path\": \".circleci/some-pipeline.yml\"\n },\n \"checkout_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a59c3040-cfd2-4080-add9-ef22d27be4d6", + "name": "projects/{project_id}/pipeline-definitions/{pipeline_definition_id} - Delete pipeline definition", + "request": { + "name": "Delete pipeline definition", + "description": { + "content": "Delete pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app` or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "a0e6cc0b-0112-4b28-bd6d-29793a06d678", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb5ca54f-e8ac-4adf-8961-a3a98c43d926", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecb2fff7-133a-4ee2-8bac-25e7892609c6", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c30b85de-e5ea-4d50-b820-49e0f0a3cd49", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67ed121f-55b5-42ab-be03-ddfb1521c4e2", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "968c2742-cd86-4a1d-8e97-0544f959d57f", + "name": "triggers", + "item": [ + { + "id": "2fe44950-4551-4985-9c2a-729c000fba8f", + "name": "projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers - List pipeline definition triggers", + "request": { + "name": "List pipeline definition triggers", + "description": { + "content": "List all triggers for a given pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app` or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "894ea753-f348-4f69-a6fb-a772093badab", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"items\": [\n {\n \"id\": \"57f0c0d2-320a-065c-dda5-984be9a90692\",\n \"event_name\": \"some event name\",\n \"created_at\": \"1959-06-05T19:40:25.428Z\",\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"url\": \"https://some-webhook.invalid/some-endpoint?secret=some-secret\",\n \"sender\": \"datadog\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\"\n },\n {\n \"id\": \"d6f35d65-6bbb-39f7-2514-bc0950760364\",\n \"event_name\": \"some event name\",\n \"created_at\": \"1978-05-25T16:27:11.378Z\",\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"url\": \"https://some-webhook.invalid/some-endpoint?secret=some-secret\",\n \"sender\": \"datadog\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "193a46e5-c84e-4c82-bb64-1a4d1e17f7d9", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7985c5fa-ebea-4053-b63e-daa179548008", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e98bbe57-46cd-428b-8ff1-9e8685f18f4e", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a081a9fa-eeb0-4ceb-b068-cc0ee40a21a0", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f5d649f7-434d-4878-9e5e-3cf477811250", + "name": "projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers - Create trigger", + "request": { + "name": "Create trigger", + "description": { + "content": "Create a trigger for a given pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"event_source\": {\n \"provider\": \"\",\n \"repo\": {\n \"external_id\": \"\"\n },\n \"webhook\": {\n \"sender\": \"\"\n }\n },\n \"event_preset\": \"\",\n \"checkout_ref\": \"\",\n \"config_ref\": \"\",\n \"event_name\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d1f49b6e-d416-4217-94d1-258bf78e581b", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"sender\": \"some-webhook-sender\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some-event-name\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"e3f47624-4fa2-713c-939f-9df24033d28d\",\n \"event_name\": \"some event name\",\n \"created_at\": \"1969-06-04T17:46:03.286Z\",\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"url\": \"https://some-webhook.invalid/some-endpoint?secret=some-secret\",\n \"sender\": \"datadog\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08e80547-67bd-470d-8dd2-e7625807f1e0", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"sender\": \"some-webhook-sender\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some-event-name\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "21715f4b-316b-4ce1-aeaf-a7622329f8bc", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"sender\": \"some-webhook-sender\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some-event-name\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96f35566-5591-4212-8c03-7232cb0a7a98", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"sender\": \"some-webhook-sender\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some-event-name\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5e30b65f-fa9a-490c-b412-d8294315d526", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "pipeline-definitions", + ":pipeline_definition_id", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "pipeline_definition_id", + "description": "(Required) An opaque identifier of a pipeline definition." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"sender\": \"some-webhook-sender\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some-event-name\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [] + }, + { + "id": "b8dfcb14-6377-47f6-bad2-e9b9a5ae4587", + "name": "triggers/{trigger_id}", + "item": [ + { + "id": "6000b346-4dc2-470a-8f95-c7e6a6b0b3ef", + "name": "projects/{project_id}/triggers/{trigger_id} - Get trigger", + "request": { + "name": "Get trigger", + "description": { + "content": "Get details for a trigger. Currently only supported for triggers where `event_source.provider` is `github_app`, `bitbucket_dc` or `webhook`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. Breaking change [upcoming on May 27, 2025](https://discuss.circleci.com/t/upcoming-changes-1-breaking-to-crud-trigger-v2-apis-may-27-2025/53314).", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "auth": null + }, + "response": [ + { + "id": "7c68fe2c-2e66-4b6a-98ca-c074a21c5419", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"e3f47624-4fa2-713c-939f-9df24033d28d\",\n \"event_name\": \"some event name\",\n \"created_at\": \"1969-06-04T17:46:03.286Z\",\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"url\": \"https://some-webhook.invalid/some-endpoint?secret=some-secret\",\n \"sender\": \"datadog\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "622b0809-ba11-4335-ad5e-fa051e3c310c", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5409ac7c-6724-4194-a231-66b62f7ee9e3", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a4cb978-11e3-4feb-bf45-c8817172b9cd", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48303052-d6dd-4ad3-a08f-aed9ea185395", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5af8f396-88dc-4b00-9fa8-5c399fce6683", + "name": "projects/{project_id}/triggers/{trigger_id} - Update trigger", + "request": { + "name": "Update trigger", + "description": { + "content": "Update a trigger. Currently only supported for triggers where `event_source.provider` is `github_app`, `bitbucket_dc` or `webhook`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"event_preset\": \"\",\n \"checkout_ref\": \"\",\n \"config_ref\": \"\",\n \"event_name\": \"\",\n \"event_source\": {\n \"webhook\": {\n \"sender\": \"\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "bf8f8cac-426c-4862-bee1-f9c0bebd0c98", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some event name\",\n \"event_source\": {\n \"webhook\": {\n \"sender\": \"some sender\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"e3f47624-4fa2-713c-939f-9df24033d28d\",\n \"event_name\": \"some event name\",\n \"created_at\": \"1969-06-04T17:46:03.286Z\",\n \"event_source\": {\n \"provider\": \"github_app\",\n \"repo\": {\n \"full_name\": \"some-org/some-repo-name\",\n \"external_id\": \"some-repo-id\"\n },\n \"webhook\": {\n \"url\": \"https://some-webhook.invalid/some-endpoint?secret=some-secret\",\n \"sender\": \"datadog\"\n }\n },\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba3a84b9-37d8-4a82-9086-b466cd9ee9de", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some event name\",\n \"event_source\": {\n \"webhook\": {\n \"sender\": \"some sender\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25c6498c-c551-4177-b109-1af269faddf7", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some event name\",\n \"event_source\": {\n \"webhook\": {\n \"sender\": \"some sender\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "90cecbda-5f77-4550-b733-8aed3d6e23c1", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some event name\",\n \"event_source\": {\n \"webhook\": {\n \"sender\": \"some sender\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3948567-0359-49e3-b53b-213b45f2b0d4", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"event_preset\": \"all-pushes\",\n \"checkout_ref\": \"some-checkout-ref\",\n \"config_ref\": \"some-config-ref\",\n \"event_name\": \"some event name\",\n \"event_source\": {\n \"webhook\": {\n \"sender\": \"some sender\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "872c4ef8-215d-4f68-b4de-5258a69ff899", + "name": "projects/{project_id}/triggers/{trigger_id} - Delete trigger", + "request": { + "name": "Delete trigger", + "description": { + "content": "Delete a trigger. Currently only supported for triggers where `event_source.provider` is `github_app`, `bitbucket_dc` or `webhook`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "auth": null + }, + "response": [ + { + "id": "d8024a0c-58d9-44d4-9c5c-dea5227d7478", + "name": "Successful response.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"string\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7585cb67-ac24-4131-8d95-0c617c2a4fa8", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30178f3b-83e0-4e80-83c0-c332756501ad", + "name": "Credentials provided are invalid.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Invalid token provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16663111-207a-43a5-9b6d-1094926d119d", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d381daa1-a61f-4939-a177-70abb2b5c0d7", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "triggers", + ":trigger_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + }, + { + "disabled": false, + "type": "any", + "value": "", + "key": "trigger_id", + "description": "(Required) An opaque identifier of a trigger." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + }, + { + "id": "2e9e1537-8619-4506-b5af-9efb98773fed", + "name": "projects/{project_id} - Rollback a project", + "request": { + "name": "Rollback a project", + "description": { + "content": "Performs a rollback operation by triggering a rollback pipeline.", + "type": "text/plain" + }, + "url": { + "path": [ + "projects", + ":project_id", + "rollback" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"environment_name\": \"\",\n \"component_name\": \"\",\n \"current_version\": \"\",\n \"target_version\": \"\",\n \"namespace\": \"\",\n \"parameters\": {\n \"key_0\": {}\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "id": "0a2957f3-4445-414a-a2fb-0e30df15d7fe", + "name": "Rollback request accepted.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "rollback" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"environment_name\": \"production\",\n \"component_name\": \"frontend\",\n \"current_version\": \"1.0.0\",\n \"target_version\": \"1.0.1\",\n \"namespace\": \"default\",\n \"parameters\": {\n \"key_0\": {}\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"rollback_type\": \"PIPELINE\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "39d480e7-fd0a-4347-8a89-b6cc2289b420", + "name": "Unexpected request body provided.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "rollback" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"environment_name\": \"production\",\n \"component_name\": \"frontend\",\n \"current_version\": \"1.0.0\",\n \"target_version\": \"1.0.1\",\n \"namespace\": \"default\",\n \"parameters\": {\n \"key_0\": {}\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Unexpected request body provided.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9c2e1b6-8cc1-49db-a132-381ddb739781", + "name": "Entity not found.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "rollback" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"environment_name\": \"production\",\n \"component_name\": \"frontend\",\n \"current_version\": \"1.0.0\",\n \"target_version\": \"1.0.1\",\n \"namespace\": \"default\",\n \"parameters\": {\n \"key_0\": {}\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Context not found.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b7e2806d-d1aa-48c2-82cb-cb3af3a4560a", + "name": "A conflict has occurred while attempting to create the resource.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "rollback" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"environment_name\": \"production\",\n \"component_name\": \"frontend\",\n \"current_version\": \"1.0.0\",\n \"target_version\": \"1.0.1\",\n \"namespace\": \"default\",\n \"parameters\": {\n \"key_0\": {}\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Conflict", + "code": 409, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Conflict creating entity.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13d99818-ccbe-45fc-98ce-169220c248ed", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "projects", + ":project_id", + "rollback" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "type": "any", + "value": "", + "key": "project_id", + "description": "(Required) An opaque identifier of a project." + } + ] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "Circle-Token", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"environment_name\": \"production\",\n \"component_name\": \"frontend\",\n \"current_version\": \"1.0.0\",\n \"target_version\": \"1.0.1\",\n \"namespace\": \"default\",\n \"parameters\": {\n \"key_0\": {}\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"Internal server error.\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [] + } + ], + "event": [], + "variable": [ + { + "type": "string", + "value": "https://circleci.com/api/v2", + "key": "baseUrl" + } + ], + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Circle-Token" + }, + { + "key": "value", + "value": "{{apiKey}}" + }, + { + "key": "in", + "value": "header" + } + ] + }, + "info": { + "_postman_id": "450dca17-48c4-4f1c-b0be-d5e261933a05", + "name": "CircleCI API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "This describes the resources that make up the CircleCI API v2.", + "type": "text/plain" + } + } +} \ No newline at end of file