{ "info": { "_postman_id": "0fbca38e-0209-4e16-aabb-52264aebbf44", "name": "CircleCI REST API v1 Artifact Resource Class API", "description": "The CircleCI REST API v1 is the legacy API that provides access to build information, project details, and user data. While still available, CircleCI recommends migrating to the v2 API for newer features and improved functionality. The v1 API supports operations for retrieving build details, triggering builds, managing SSH keys, and accessing test metadata. Authentication is handled through API tokens passed as query parameters or HTTP headers.\n\nContact Support:\n Name: CircleCI Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "lastUpdatedBy": "35240", "uid": "35240-0fbca38e-0209-4e16-aabb-52264aebbf44" }, "item": [ { "name": "runner", "item": [ { "name": "resource-class", "item": [ { "name": "{resource-class}", "item": [ { "name": "Get a resource class", "id": "917bc4c7-8d44-49ac-aa23-cb6b781729ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "id": "7686ed1d-e513-46ae-814a-9a6b643e8a9c", "key": "resource-class", "value": "", "description": "(Required) The resource class in namespace/name format" } ] }, "description": "Returns details about a specific resource class." }, "response": [ { "id": "1627ce5b-88bb-4483-9d6d-78e2e3270770", "name": "Successfully retrieved resource class", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "key": "resource-class" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"resource_class\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-1627ce5b-88bb-4483-9d6d-78e2e3270770" }, { "id": "1e34a341-f4b8-42d3-a733-fa4e3055ff9d", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "key": "resource-class" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-1e34a341-f4b8-42d3-a733-fa4e3055ff9d" }, { "id": "a43f3d29-dfdd-49d3-a3ac-4b2755dfb8a2", "name": "Resource class not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "key": "resource-class" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-a43f3d29-dfdd-49d3-a3ac-4b2755dfb8a2" } ], "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-917bc4c7-8d44-49ac-aa23-cb6b781729ba" }, { "name": "Delete a resource class", "id": "44f7f86e-a383-4abf-a30c-56f6dc3f73e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "id": "01187aaf-7d47-4c52-a899-450175fb6faa", "key": "resource-class", "value": "", "description": "(Required) The resource class in namespace/name format" } ] }, "description": "Deletes a resource class. This will prevent any runners using this resource class from picking up new tasks." }, "response": [ { "id": "d6950675-10c0-4d82-b2bc-a29e6d99d0c8", "name": "Resource class deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "key": "resource-class" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-d6950675-10c0-4d82-b2bc-a29e6d99d0c8" }, { "id": "49030c61-cea8-4958-9260-e20d7eb9973d", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "key": "resource-class" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-49030c61-cea8-4958-9260-e20d7eb9973d" }, { "id": "96e44633-cac2-45df-b2ba-4bf47d596340", "name": "Resource class not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class/:resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class", ":resource-class" ], "variable": [ { "key": "resource-class" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-96e44633-cac2-45df-b2ba-4bf47d596340" } ], "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-44f7f86e-a383-4abf-a30c-56f6dc3f73e6" } ], "id": "b6a91e1a-cc95-4fd4-a680-97f693158dd9", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-b6a91e1a-cc95-4fd4-a680-97f693158dd9" }, { "name": "List resource classes", "id": "a79d99b5-d37f-40fe-9390-7bd2d38c1ba1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class?namespace=", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class" ], "query": [ { "description": "(Required) The namespace to list resource classes for", "key": "namespace", "value": "" } ] }, "description": "Returns a list of runner resource classes for the specified namespace. Resource classes define the compute resources available for self-hosted runner jobs." }, "response": [ { "id": "beda69dd-21d5-4bbb-99ea-d9437a2d7362", "name": "Successfully retrieved resource classes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class?namespace=", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class" ], "query": [ { "description": "(Required) The namespace to list resource classes for", "key": "namespace", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"resource_class\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"resource_class\": \"\",\n \"description\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-beda69dd-21d5-4bbb-99ea-d9437a2d7362" }, { "id": "acdbf143-fd56-4457-b5eb-c59245fd4ef6", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/runner/resource-class?namespace=", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class" ], "query": [ { "description": "(Required) The namespace to list resource classes for", "key": "namespace", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-acdbf143-fd56-4457-b5eb-c59245fd4ef6" } ], "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-a79d99b5-d37f-40fe-9390-7bd2d38c1ba1" }, { "name": "Create a resource class", "id": "785d58f2-c2d3-41ce-b64c-ab51f2038926", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"resource_class\": \"gu0pyovwx9h/9vfvg\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/runner/resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class" ] }, "description": "Creates a new resource class for the specified namespace. Returns a resource class token that is only displayed once and cannot be retrieved again. This token is used by runner agents to authenticate." }, "response": [ { "id": "a6393c6e-697b-47ee-8342-04f9f80ed099", "name": "Resource class created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"resource_class\": \"gu0pyovwx9h/9vfvg\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/runner/resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"resource_class\": \"\",\n \"description\": \"\",\n \"token\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-a6393c6e-697b-47ee-8342-04f9f80ed099" }, { "id": "5f0b6f6c-8085-4484-b223-bc190e6a67eb", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"resource_class\": \"gu0pyovwx9h/9vfvg\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/runner/resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-5f0b6f6c-8085-4484-b223-bc190e6a67eb" }, { "id": "bb4f1298-da6d-4603-a172-a63393541b57", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"resource_class\": \"gu0pyovwx9h/9vfvg\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/runner/resource-class", "host": [ "{{baseUrl}}" ], "path": [ "runner", "resource-class" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-bb4f1298-da6d-4603-a172-a63393541b57" } ], "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-785d58f2-c2d3-41ce-b64c-ab51f2038926" } ], "id": "f7971de7-fef4-434d-b59a-d9416cc174ae", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-f7971de7-fef4-434d-b59a-d9416cc174ae" } ], "id": "26ef765e-b372-49d6-b806-6e6ca214a477", "createdAt": "2026-07-28T01:21:16.000Z", "updatedAt": "2026-07-28T01:21:16.000Z", "uid": "35240-26ef765e-b372-49d6-b806-6e6ca214a477" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Circle-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://circleci.com/api/v1.1" } ] }