{ "info": { "name": "Routebase Public API", "description": "This reference covers the part of the Routebase API that is a commitment to\ncustomers. Every endpoint here is called by a shipped Routebase client, so it is\nalready a contract in practice. The test CLI on nuget.org drives the CI, spec,\nsecurity and docs-as-code groups, and identity providers such as Okta and\nMicrosoft Entra drive the SCIM group.\n\nEverything else under \u0060/api/**\u0060 serves the Routebase web app, can change without\nnotice, and should not be built against.\n\nThe API is not versioned by path, and the version above numbers this document\nrather than the API. A breaking change here is announced in the release notes\nbefore it ships.\n\n## Authentication\n\nSend an API key in the \u0060X-API-Key\u0060 header. Keys are created under Settings then\nAPI Keys, they start with \u0060rb_live_\u0060, and each one carries its own permission\nscopes and an optional restriction to a single project. A scoped key cannot reach\norganization level operations at all, so grant the least privilege that works.\n\nSCIM is the exception and authenticates with a separate bearer token, issued per\norganization when SCIM provisioning is enabled.\n\n## Regions\n\nAn organization lives in exactly one region. US organizations must send the\n\u0060X-RB-Region\u0060 header documented on every operation, otherwise the request is\nrouted to the EU region and answered with 401.\n\n## Rate limits\n\nRequests are counted in a rolling window of 60 seconds. A call authenticated with\nan API key gets 5,000 requests per window, counted per user of that key, so all\nkeys of a user share one budget. SCIM is counted per source IP instead and gets 100\nrequests per window, so every call from one identity provider shares a single\nbudget. Exceeding it answers \u0060429\u0060 with a \u0060Retry-After\u0060 header, which a polling CI\njob should honour rather than retry immediately. Responses also carry \u0060RateLimit\u0060\nand \u0060RateLimit-Policy\u0060 headers that show the remaining budget, and a response can\narrive without them.\n\n## Errors\n\nFailures return \u0060application/problem\u002Bjson\u0060 with a machine readable \u0060code\u0060 field.\nRead that rather than the human readable \u0060detail\u0060, which may be reworded. SCIM\nendpoints return the SCIM error envelope instead. Resources are identified by public\nUUIDs. Scanner and guidance ids are string keys, and a SCIM \u0060externalId\u0060 is whatever\nyour identity provider sends.", "version": "1.2.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "CI \u0026 Test Runs", "item": [ { "name": "List the environments of a project", "description": "Returns the environments of a project, so a pipeline can pick the one whose\nvariables the run should use. An environment marked \u0060isReadOnly\u0060 rejects every\nwrite request sent to it, and the test cases concerned are reported as blocked\nrather than failed.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/cli/environments?projectId=00000000-0000-0000-0000-000000000000", "host": [ "{{base_url}}" ], "path": [ "api", "cli", "environments" ], "query": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." } ] }, "description": "Returns the environments of a project, so a pipeline can pick the one whose\nvariables the run should use. An environment marked \u0060isReadOnly\u0060 rejects every\nwrite request sent to it, and the test cases concerned are reported as blocked\nrather than failed.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022name\u0022: \u0022string\u0022,\n \u0022type\u0022: \u0022development\u0022,\n \u0022baseUrl\u0022: \u0022string\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022variableCount\u0022: 0,\n \u0022freezesVersion\u0022: true,\n \u0022isDocsSource\u0022: true,\n \u0022isMockSource\u0022: true,\n \u0022isReadOnly\u0022: true\n }\n]", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Run a test suite and wait for the result", "description": "Executes a test suite and returns the outcome in one call, which is what a\npipeline step needs. The response tells you whether everything passed, so a\nCI job can fail on \u0060allPassed\u0060 alone. Pass a \u0060reportFormat\u0060 to get the report\ninline instead of downloading it separately.\n\nThe call blocks until the run finishes. For a long suite, send \u0060progressRunId\u0060\nand poll the status endpoint instead of holding the connection open.\n", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \u0022projectId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022suiteId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022environmentId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022iterations\u0022: 0,\n \u0022delayMs\u0022: 0,\n \u0022onError\u0022: \u0022ignore\u0022,\n \u0022reportFormat\u0022: \u0022json\u0022,\n \u0022threads\u0022: 0,\n \u0022authOverrideJson\u0022: \u0022string\u0022\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/cli/run", "host": [ "{{base_url}}" ], "path": [ "api", "cli", "run" ] }, "description": "Executes a test suite and returns the outcome in one call, which is what a\npipeline step needs. The response tells you whether everything passed, so a\nCI job can fail on \u0060allPassed\u0060 alone. Pass a \u0060reportFormat\u0060 to get the report\ninline instead of downloading it separately.\n\nThe call blocks until the run finishes. For a long suite, send \u0060progressRunId\u0060\nand poll the status endpoint instead of holding the connection open.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022allPassed\u0022: true,\n \u0022totalElapsedMs\u0022: 0,\n \u0022totalTests\u0022: 0,\n \u0022passedTests\u0022: 0,\n \u0022failedTests\u0022: 0,\n \u0022testRunId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022iterations\u0022: 0,\n \u0022iterationResults\u0022: [\n {\n \u0022iterationNumber\u0022: 0,\n \u0022results\u0022: [\n {\n \u0022statusCode\u0022: 0,\n \u0022statusText\u0022: \u0022string\u0022,\n \u0022headers\u0022: {},\n \u0022body\u0022: \u0022string\u0022,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022error\u0022: \u0022string\u0022,\n \u0022resolvedUrl\u0022: \u0022string\u0022,\n \u0022resolvedMethod\u0022: \u0022string\u0022,\n \u0022unresolvedVariables\u0022: [\n \u0022string\u0022\n ],\n \u0022passed\u0022: true,\n \u0022assertionResults\u0022: [\n {\n \u0022assertionId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022type\u0022: \u0022string\u0022,\n \u0022operator\u0022: \u0022string\u0022,\n \u0022target\u0022: \u0022string\u0022,\n \u0022expectedValue\u0022: \u0022string\u0022,\n \u0022actualValue\u0022: \u0022string\u0022,\n \u0022passed\u0022: true,\n \u0022errorMessage\u0022: \u0022string\u0022,\n \u0022checkedVersionNumber\u0022: \u0022string\u0022,\n \u0022checkedVersionSource\u0022: \u0022string\u0022,\n \u0022driftedFromVersionNumber\u0022: \u0022string\u0022\n }\n ],\n \u0022testCaseId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022testCaseName\u0022: \u0022string\u0022,\n \u0022extractedVariables\u0022: {},\n \u0022consumedVariables\u0022: {},\n \u0022resolvedHeaders\u0022: {},\n \u0022resolvedBody\u0022: \u0022string\u0022,\n \u0022responseSizeBytes\u0022: 0,\n \u0022preRequestScriptOutput\u0022: [\n \u0022string\u0022\n ],\n \u0022preRequestScriptError\u0022: \u0022string\u0022,\n \u0022postResponseScriptOutput\u0022: [\n \u0022string\u0022\n ],\n \u0022postResponseScriptError\u0022: \u0022string\u0022,\n \u0022timingBreakdown\u0022: {\n \u0022dnsMs\u0022: 0,\n \u0022connectMs\u0022: 0,\n \u0022tlsMs\u0022: 0,\n \u0022firstByteMs\u0022: 0,\n \u0022downloadMs\u0022: 0,\n \u0022totalMs\u0022: 0\n },\n \u0022isPending\u0022: true,\n \u0022isBlocked\u0022: true\n }\n ],\n \u0022allPassed\u0022: true,\n \u0022elapsedMs\u0022: 0,\n \u0022wasAborted\u0022: true,\n \u0022dataRowIndex\u0022: 0,\n \u0022dataRowValues\u0022: {}\n }\n ],\n \u0022report\u0022: \u0022string\u0022,\n \u0022reportFormat\u0022: \u0022string\u0022,\n \u0022reportContentType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Download the report of a finished run", "description": "Returns the run report as a file. JUnit XML is the default because GitHub\nActions, Azure Pipelines and Jenkins all read it natively.\n\nThe run has to be finished. Asking for the report of a pending or running test\nrun is answered with 409, so poll the status endpoint first.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/cli/runs/:id/report", "host": [ "{{base_url}}" ], "path": [ "api", "cli", "runs", ":id", "report" ], "query": [ { "key": "format", "value": "", "description": "Report format. Defaults to \u0060junit\u0060.", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the test run." } ] }, "description": "Returns the run report as a file. JUnit XML is the default because GitHub\nActions, Azure Pipelines and Jenkins all read it natively.\n\nThe run has to be finished. Asking for the report of a pending or running test\nrun is answered with 409, so poll the status endpoint first.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\u0022string\u0022", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get the progress of a test run", "description": "Returns how far a run has come, which lets a pipeline show progress instead of\nwaiting silently. While the run is going, \u0060currentDurationMs\u0060 counts up and\n\u0060completedAt\u0060 stays null.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/cli/runs/:id/status", "host": [ "{{base_url}}" ], "path": [ "api", "cli", "runs", ":id", "status" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the test run." } ] }, "description": "Returns how far a run has come, which lets a pipeline show progress instead of\nwaiting silently. While the run is going, \u0060currentDurationMs\u0060 counts up and\n\u0060completedAt\u0060 stays null.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022status\u0022: \u0022pending\u0022,\n \u0022completedCases\u0022: 0,\n \u0022totalCases\u0022: 0,\n \u0022passedCases\u0022: 0,\n \u0022failedCases\u0022: 0,\n \u0022currentDurationMs\u0022: 0,\n \u0022startedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022completedAt\u0022: \u00222024-01-01T00:00:00Z\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List the test suites of a project for a CI pipeline", "description": "Returns the test suites of a project so a pipeline can resolve a suite by name.", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/cli/suites?projectId=00000000-0000-0000-0000-000000000000", "host": [ "{{base_url}}" ], "path": [ "api", "cli", "suites" ], "query": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "skip", "value": "1", "description": "Number of items to skip. Defaults to 0.", "disabled": true }, { "key": "take", "value": "1", "description": "Maximum number of items to return.", "disabled": true } ] }, "description": "Returns the test suites of a project so a pipeline can resolve a suite by name.", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022items\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022name\u0022: \u0022string\u0022,\n \u0022description\u0022: \u0022string\u0022,\n \u0022tags\u0022: [\n \u0022string\u0022\n ],\n \u0022testCaseCount\u0022: 0,\n \u0022authMode\u0022: \u0022string\u0022,\n \u0022authType\u0022: \u0022string\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022modifiedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022fixtureScopeJson\u0022: \u0022string\u0022,\n \u0022testSuiteFolderId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022\n }\n ],\n \u0022totalCount\u0022: 0\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List the test suites of a project", "description": "The project scoped equivalent of \u0060/api/cli/suites\u0060, which returns the same page\nof suites. Use whichever fits the path style of your client.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/test-suites", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "test-suites" ], "query": [ { "key": "skip", "value": "1", "description": "Number of items to skip. Defaults to 0.", "disabled": true }, { "key": "take", "value": "1", "description": "Maximum number of items to return.", "disabled": true } ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." } ] }, "description": "The project scoped equivalent of \u0060/api/cli/suites\u0060, which returns the same page\nof suites. Use whichever fits the path style of your client.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022items\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022name\u0022: \u0022string\u0022,\n \u0022description\u0022: \u0022string\u0022,\n \u0022tags\u0022: [\n \u0022string\u0022\n ],\n \u0022testCaseCount\u0022: 0,\n \u0022authMode\u0022: \u0022string\u0022,\n \u0022authType\u0022: \u0022string\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022modifiedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022fixtureScopeJson\u0022: \u0022string\u0022,\n \u0022testSuiteFolderId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022\n }\n ],\n \u0022totalCount\u0022: 0\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Execute a test suite", "description": "Runs every test case in a suite in order, carrying extracted variables from one\ncase into the next. This is the full result shape, so it also carries the\nper-case detail, the seed results and the performance metrics that\n\u0060/api/cli/run\u0060 leaves out.\n\nSet \u0060persistResults\u0060 to false for a dry run that leaves no test run behind.\n", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \u0022environmentId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022persistResults\u0022: true,\n \u0022iterations\u0022: 0,\n \u0022delayMs\u0022: 0,\n \u0022onError\u0022: \u0022ignore\u0022,\n \u0022dataSetId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022threads\u0022: 0,\n \u0022progressRunId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022caseIds\u0022: [\n \u002200000000-0000-0000-0000-000000000000\u0022\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/projects/:projectId/test-suites/:suiteId/execute", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "test-suites", ":suiteId", "execute" ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "suiteId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the test suite." } ] }, "description": "Runs every test case in a suite in order, carrying extracted variables from one\ncase into the next. This is the full result shape, so it also carries the\nper-case detail, the seed results and the performance metrics that\n\u0060/api/cli/run\u0060 leaves out.\n\nSet \u0060persistResults\u0060 to false for a dry run that leaves no test run behind.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022results\u0022: [\n {\n \u0022statusCode\u0022: 0,\n \u0022statusText\u0022: \u0022string\u0022,\n \u0022headers\u0022: {},\n \u0022body\u0022: \u0022string\u0022,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022error\u0022: \u0022string\u0022,\n \u0022resolvedUrl\u0022: \u0022string\u0022,\n \u0022resolvedMethod\u0022: \u0022string\u0022,\n \u0022unresolvedVariables\u0022: [\n \u0022string\u0022\n ],\n \u0022passed\u0022: true,\n \u0022assertionResults\u0022: [\n {\n \u0022assertionId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022type\u0022: \u0022string\u0022,\n \u0022operator\u0022: \u0022string\u0022,\n \u0022target\u0022: \u0022string\u0022,\n \u0022expectedValue\u0022: \u0022string\u0022,\n \u0022actualValue\u0022: \u0022string\u0022,\n \u0022passed\u0022: true,\n \u0022errorMessage\u0022: \u0022string\u0022,\n \u0022checkedVersionNumber\u0022: \u0022string\u0022,\n \u0022checkedVersionSource\u0022: \u0022string\u0022,\n \u0022driftedFromVersionNumber\u0022: \u0022string\u0022\n }\n ],\n \u0022testCaseId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022testCaseName\u0022: \u0022string\u0022,\n \u0022extractedVariables\u0022: {},\n \u0022consumedVariables\u0022: {},\n \u0022resolvedHeaders\u0022: {},\n \u0022resolvedBody\u0022: \u0022string\u0022,\n \u0022responseSizeBytes\u0022: 0,\n \u0022preRequestScriptOutput\u0022: [\n \u0022string\u0022\n ],\n \u0022preRequestScriptError\u0022: \u0022string\u0022,\n \u0022postResponseScriptOutput\u0022: [\n \u0022string\u0022\n ],\n \u0022postResponseScriptError\u0022: \u0022string\u0022,\n \u0022timingBreakdown\u0022: {\n \u0022dnsMs\u0022: 0,\n \u0022connectMs\u0022: 0,\n \u0022tlsMs\u0022: 0,\n \u0022firstByteMs\u0022: 0,\n \u0022downloadMs\u0022: 0,\n \u0022totalMs\u0022: 0\n },\n \u0022isPending\u0022: true,\n \u0022isBlocked\u0022: true\n }\n ],\n \u0022extractedVariables\u0022: {},\n \u0022allPassed\u0022: true,\n \u0022totalElapsedMs\u0022: 0,\n \u0022testRunPublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022iterations\u0022: 0,\n \u0022iterationResults\u0022: [\n {\n \u0022iterationNumber\u0022: 0,\n \u0022results\u0022: [\n {\n \u0022statusCode\u0022: 0,\n \u0022statusText\u0022: \u0022string\u0022,\n \u0022headers\u0022: {},\n \u0022body\u0022: \u0022string\u0022,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022error\u0022: \u0022string\u0022,\n \u0022resolvedUrl\u0022: \u0022string\u0022,\n \u0022resolvedMethod\u0022: \u0022string\u0022,\n \u0022unresolvedVariables\u0022: [\n \u0022string\u0022\n ],\n \u0022passed\u0022: true,\n \u0022assertionResults\u0022: [\n {\n \u0022assertionId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022type\u0022: \u0022string\u0022,\n \u0022operator\u0022: \u0022string\u0022,\n \u0022target\u0022: \u0022string\u0022,\n \u0022expectedValue\u0022: \u0022string\u0022,\n \u0022actualValue\u0022: \u0022string\u0022,\n \u0022passed\u0022: true,\n \u0022errorMessage\u0022: \u0022string\u0022,\n \u0022checkedVersionNumber\u0022: \u0022string\u0022,\n \u0022checkedVersionSource\u0022: \u0022string\u0022,\n \u0022driftedFromVersionNumber\u0022: \u0022string\u0022\n }\n ],\n \u0022testCaseId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022testCaseName\u0022: \u0022string\u0022,\n \u0022extractedVariables\u0022: {},\n \u0022consumedVariables\u0022: {},\n \u0022resolvedHeaders\u0022: {},\n \u0022resolvedBody\u0022: \u0022string\u0022,\n \u0022responseSizeBytes\u0022: 0,\n \u0022preRequestScriptOutput\u0022: [\n \u0022string\u0022\n ],\n \u0022preRequestScriptError\u0022: \u0022string\u0022,\n \u0022postResponseScriptOutput\u0022: [\n \u0022string\u0022\n ],\n \u0022postResponseScriptError\u0022: \u0022string\u0022,\n \u0022timingBreakdown\u0022: {\n \u0022dnsMs\u0022: 0,\n \u0022connectMs\u0022: 0,\n \u0022tlsMs\u0022: 0,\n \u0022firstByteMs\u0022: 0,\n \u0022downloadMs\u0022: 0,\n \u0022totalMs\u0022: 0\n },\n \u0022isPending\u0022: true,\n \u0022isBlocked\u0022: true\n }\n ],\n \u0022allPassed\u0022: true,\n \u0022elapsedMs\u0022: 0,\n \u0022wasAborted\u0022: true,\n \u0022dataRowIndex\u0022: 0,\n \u0022dataRowValues\u0022: {}\n }\n ],\n \u0022dataSetName\u0022: \u0022string\u0022,\n \u0022dataRowCount\u0022: 0,\n \u0022threads\u0022: 0,\n \u0022performanceMetrics\u0022: {\n \u0022averageResponseTimeMs\u0022: 0,\n \u0022minResponseTimeMs\u0022: 0,\n \u0022maxResponseTimeMs\u0022: 0,\n \u0022medianResponseTimeMs\u0022: 0,\n \u0022p95ResponseTimeMs\u0022: 0,\n \u0022p99ResponseTimeMs\u0022: 0,\n \u0022throughputPerSecond\u0022: 0,\n \u0022errorRatePercent\u0022: 0,\n \u0022totalRequests\u0022: 0,\n \u0022successfulRequests\u0022: 0,\n \u0022failedRequests\u0022: 0,\n \u0022perTestCase\u0022: [\n {\n \u0022testCaseId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022testCaseName\u0022: \u0022string\u0022,\n \u0022averageResponseTimeMs\u0022: 0,\n \u0022minResponseTimeMs\u0022: 0,\n \u0022maxResponseTimeMs\u0022: 0,\n \u0022p95ResponseTimeMs\u0022: 0,\n \u0022errorRatePercent\u0022: 0,\n \u0022requestCount\u0022: 0\n }\n ]\n },\n \u0022preRunSeedResult\u0022: {\n \u0022success\u0022: true,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022stepResults\u0022: [\n {\n \u0022order\u0022: 0,\n \u0022type\u0022: \u0022string\u0022,\n \u0022success\u0022: true,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022statusCode\u0022: 0,\n \u0022error\u0022: \u0022string\u0022,\n \u0022resolvedUrl\u0022: \u0022string\u0022,\n \u0022resolvedMethod\u0022: \u0022string\u0022,\n \u0022iterationIndex\u0022: 0,\n \u0022capturedVariables\u0022: {}\n }\n ],\n \u0022capturedVariables\u0022: {},\n \u0022error\u0022: \u0022string\u0022\n },\n \u0022postRunSeedResult\u0022: {\n \u0022success\u0022: true,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022stepResults\u0022: [\n {\n \u0022order\u0022: 0,\n \u0022type\u0022: \u0022string\u0022,\n \u0022success\u0022: true,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022statusCode\u0022: 0,\n \u0022error\u0022: \u0022string\u0022,\n \u0022resolvedUrl\u0022: \u0022string\u0022,\n \u0022resolvedMethod\u0022: \u0022string\u0022,\n \u0022iterationIndex\u0022: 0,\n \u0022capturedVariables\u0022: {}\n }\n ],\n \u0022capturedVariables\u0022: {},\n \u0022error\u0022: \u0022string\u0022\n },\n \u0022resetSnapshotResult\u0022: {\n \u0022success\u0022: true,\n \u0022phase\u0022: \u0022string\u0022,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022cleanupResults\u0022: [\n {\n \u0022order\u0022: 0,\n \u0022method\u0022: \u0022string\u0022,\n \u0022url\u0022: \u0022string\u0022,\n \u0022success\u0022: true,\n \u0022statusCode\u0022: 0,\n \u0022error\u0022: \u0022string\u0022,\n \u0022elapsedMilliseconds\u0022: 0\n }\n ],\n \u0022reSeedResult\u0022: {\n \u0022success\u0022: true,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022stepResults\u0022: [\n {\n \u0022order\u0022: 0,\n \u0022type\u0022: \u0022string\u0022,\n \u0022success\u0022: true,\n \u0022elapsedMilliseconds\u0022: 0,\n \u0022statusCode\u0022: 0,\n \u0022error\u0022: \u0022string\u0022,\n \u0022resolvedUrl\u0022: \u0022string\u0022,\n \u0022resolvedMethod\u0022: \u0022string\u0022,\n \u0022iterationIndex\u0022: 0,\n \u0022capturedVariables\u0022: {}\n }\n ],\n \u0022capturedVariables\u0022: {},\n \u0022error\u0022: \u0022string\u0022\n },\n \u0022warnings\u0022: [\n \u0022string\u0022\n ],\n \u0022error\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Docs as Code", "item": [ { "name": "List the documentations of a project", "description": "Returns the documentations of a project with their versions, which is how a\npipeline finds the id of the version it should write into. Only a version whose\nstatus is \u0060draft\u0060 or \u0060review\u0060 accepts changes, so pick one of those.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/docs", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "docs" ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." } ] }, "description": "Returns the documentations of a project with their versions, which is how a\npipeline finds the id of the version it should write into. Only a version whose\nstatus is \u0060draft\u0060 or \u0060review\u0060 accepts changes, so pick one of those.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022documentations\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022customDomain\u0022: \u0022string\u0022,\n \u0022customDomainVerified\u0022: true,\n \u0022branding\u0022: {\n \u0022logoUrl\u0022: \u0022string\u0022,\n \u0022primaryColor\u0022: \u0022string\u0022,\n \u0022accentColor\u0022: \u0022string\u0022,\n \u0022faviconUrl\u0022: \u0022string\u0022,\n \u0022footerText\u0022: \u0022string\u0022\n },\n \u0022versioningScheme\u0022: \u0022semantic\u0022,\n \u0022requireApproval\u0022: true,\n \u0022portalEnabled\u0022: true,\n \u0022versions\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022versionNumber\u0022: 0,\n \u0022status\u0022: \u0022draft\u0022,\n \u0022visibility\u0022: \u0022internal\u0022,\n \u0022publishedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022rowVersion\u0022: \u0022string\u0022\n }\n ],\n \u0022rowVersion\u0022: \u0022string\u0022\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create a folder", "description": "Creates a folder in a version. A folder with \u0060isSection\u0060 set becomes a top level\nsection in the portal header rather than an entry in the sidebar, and only a\nfolder at the root can be one.\n", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \u0022name\u0022: \u0022string\u0022,\n \u0022icon\u0022: \u0022string\u0022,\n \u0022description\u0022: \u0022string\u0022,\n \u0022parentFolderPublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022isSection\u0022: true,\n \u0022slug\u0022: \u0022string\u0022\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/projects/:projectId/docs/:docId/versions/:versionId/folders", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "docs", ":docId", "versions", ":versionId", "folders" ], "variable": [ { "key": "docId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation." }, { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation version." } ] }, "description": "Creates a folder in a version. A folder with \u0060isSection\u0060 set becomes a top level\nsection in the portal header rather than an entry in the sidebar, and only a\nfolder at the root can be one.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "201 Created", "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022slug\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create a page", "description": "Creates a page inside a version, at the root or under a folder. The slug is\nderived from the title when you do not send one, and it is what the public\nportal URL is built from, so set it explicitly if the URL matters to you.\n", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \u0022title\u0022: \u0022string\u0022,\n \u0022content\u0022: \u0022string\u0022,\n \u0022parentFolderPublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022pageType\u0022: \u0022custom\u0022,\n \u0022structuredContent\u0022: \u0022string\u0022,\n \u0022icon\u0022: \u0022string\u0022,\n \u0022slug\u0022: \u0022string\u0022\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/projects/:projectId/docs/:docId/versions/:versionId/pages", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "docs", ":docId", "versions", ":versionId", "pages" ], "variable": [ { "key": "docId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation." }, { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation version." } ] }, "description": "Creates a page inside a version, at the root or under a folder. The slug is\nderived from the title when you do not send one, and it is what the public\nportal URL is built from, so set it explicitly if the URL matters to you.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "201 Created", "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022slug\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get a page with its content", "description": "Returns one page including its Markdown content and its \u0060rowVersion\u0060. Send that\n\u0060rowVersion\u0060 back on the next update and a concurrent edit is rejected with 409\ninstead of silently overwriting someone else\u0027s work.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/docs/:docId/versions/:versionId/pages/:pageId", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "docs", ":docId", "versions", ":versionId", "pages", ":pageId" ], "variable": [ { "key": "docId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation." }, { "key": "pageId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation page." }, { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation version." } ] }, "description": "Returns one page including its Markdown content and its \u0060rowVersion\u0060. Send that\n\u0060rowVersion\u0060 back on the next update and a concurrent edit is rejected with 409\ninstead of silently overwriting someone else\u0027s work.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022slug\u0022: \u0022string\u0022,\n \u0022content\u0022: \u0022string\u0022,\n \u0022pageType\u0022: \u0022custom\u0022,\n \u0022structuredContent\u0022: \u0022string\u0022,\n \u0022icon\u0022: \u0022string\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022modifiedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022rowVersion\u0022: \u0022string\u0022,\n \u0022isLocked\u0022: true\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update a page", "description": "Replaces the title and content of a page, which is the call that carries a\nMarkdown file from your repository into Routebase. A page that a person has\nlocked in the editor is not writable, and the call is rejected until the lock is\nreleased.\n", "request": { "method": "PUT", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \u0022title\u0022: \u0022string\u0022,\n \u0022content\u0022: \u0022string\u0022,\n \u0022structuredContent\u0022: \u0022string\u0022,\n \u0022icon\u0022: \u0022string\u0022,\n \u0022expectedRowVersion\u0022: \u0022string\u0022,\n \u0022slug\u0022: \u0022string\u0022\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/projects/:projectId/docs/:docId/versions/:versionId/pages/:pageId", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "docs", ":docId", "versions", ":versionId", "pages", ":pageId" ], "variable": [ { "key": "docId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation." }, { "key": "pageId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation page." }, { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation version." } ] }, "description": "Replaces the title and content of a page, which is the call that carries a\nMarkdown file from your repository into Routebase. A page that a person has\nlocked in the editor is not writable, and the call is rejected until the lock is\nreleased.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022slug\u0022: \u0022string\u0022,\n \u0022content\u0022: \u0022string\u0022,\n \u0022pageType\u0022: \u0022custom\u0022,\n \u0022structuredContent\u0022: \u0022string\u0022,\n \u0022icon\u0022: \u0022string\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022modifiedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022rowVersion\u0022: \u0022string\u0022,\n \u0022isLocked\u0022: true\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get the page tree of a version", "description": "Returns the full hierarchy of a documentation version. Each node is exactly one\nof a page, a folder or an API reference snapshot, and the \u0060type\u0060 field says\nwhich of the three is filled.\n\nThe response carries an ETag, so a pipeline that syncs repeatedly can send\n\u0060If-None-Match\u0060 and skip the work when nothing moved.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/docs/:docId/versions/:versionId/tree", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "docs", ":docId", "versions", ":versionId", "tree" ], "variable": [ { "key": "docId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation." }, { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation version." } ] }, "description": "Returns the full hierarchy of a documentation version. Each node is exactly one\nof a page, a folder or an API reference snapshot, and the \u0060type\u0060 field says\nwhich of the three is filled.\n\nThe response carries an ETag, so a pipeline that syncs repeatedly can send\n\u0060If-None-Match\u0060 and skip the work when nothing moved.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022items\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022type\u0022: \u0022page\u0022,\n \u0022sortOrder\u0022: 0,\n \u0022page\u0022: {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022slug\u0022: \u0022string\u0022,\n \u0022pageType\u0022: \u0022custom\u0022,\n \u0022icon\u0022: \u0022string\u0022,\n \u0022modifiedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022modifiedByName\u0022: \u0022string\u0022,\n \u0022isEmpty\u0022: true,\n \u0022hasEdits\u0022: true\n },\n \u0022folder\u0022: {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022name\u0022: \u0022string\u0022,\n \u0022slug\u0022: \u0022string\u0022,\n \u0022icon\u0022: \u0022string\u0022,\n \u0022isSection\u0022: true,\n \u0022description\u0022: \u0022string\u0022,\n \u0022children\u0022: [],\n \u0022rowVersion\u0022: \u0022string\u0022\n },\n \u0022specSnapshot\u0022: {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022specName\u0022: \u0022string\u0022,\n \u0022versionNumber\u0022: \u0022string\u0022,\n \u0022endpointCount\u0022: 0,\n \u0022playgroundEnabled\u0022: true,\n \u0022autoSyncEnabled\u0022: true,\n \u0022openApiJson\u0022: \u0022string\u0022,\n \u0022sourceSpecPublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022hasNewerVersion\u0022: true,\n \u0022latestPublishedVersionNumber\u0022: \u0022string\u0022,\n \u0022endpointAnnotations\u0022: \u0022string\u0022,\n \u0022endpointSortOrders\u0022: \u0022string\u0022,\n \u0022tagSortOrders\u0022: \u0022string\u0022,\n \u0022folderDescriptions\u0022: \u0022string\u0022\n }\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "304 Unknown", "status": "Unknown", "code": 304, "header": [ { "key": "Content-Type", "value": "application/json" } ] }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Reorder the items under one parent", "description": "Sets the order of the items inside one folder, or at the root when\n\u0060parentFolderPublicId\u0060 is null. Send the complete list of ids in the order you\nwant, because the position of an item is its index in that list.\n", "request": { "method": "PUT", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \u0022parentFolderPublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022itemPublicIds\u0022: [\n \u002200000000-0000-0000-0000-000000000000\u0022\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/projects/:projectId/docs/:docId/versions/:versionId/tree/reorder", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "docs", ":docId", "versions", ":versionId", "tree", "reorder" ], "variable": [ { "key": "docId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation." }, { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the documentation version." } ] }, "description": "Sets the order of the items inside one folder, or at the root when\n\u0060parentFolderPublicId\u0060 is null. Send the complete list of ids in the order you\nwant, because the position of an item is its index in that list.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "204 No Content", "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ] }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Security", "item": [ { "name": "List security findings", "description": "Returns the findings of a project across all scans, filtered as you need them.\nA pipeline that only wants to know whether anything new broke should filter on\n\u0060status=open\u0060 and on the severities it cares about.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/security/findings", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "security", "findings" ], "query": [ { "key": "assignedToMe", "value": "true", "description": "Return only findings assigned to the calling user.", "disabled": true }, { "key": "scannerId", "value": "", "description": "Filter by the scanner that produced the finding.", "disabled": true }, { "key": "search", "value": "", "description": "Free-text search across title and description.", "disabled": true }, { "key": "severity", "value": "", "description": "Filter by severity.", "disabled": true }, { "key": "skip", "value": "1", "description": "Number of items to skip. Defaults to 0.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Sort order of the result.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by finding status.", "disabled": true }, { "key": "take", "value": "1", "description": "Maximum number of items to return. Defaults to 50.", "disabled": true } ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." } ] }, "description": "Returns the findings of a project across all scans, filtered as you need them.\nA pipeline that only wants to know whether anything new broke should filter on\n\u0060status=open\u0060 and on the severities it cares about.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022items\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022scanRunPublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022firstSeenScanRunPublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022scannerId\u0022: \u0022string\u0022,\n \u0022owaspCategory\u0022: \u0022string\u0022,\n \u0022severity\u0022: \u0022info\u0022,\n \u0022confidence\u0022: \u0022low\u0022,\n \u0022status\u0022: \u0022open\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022description\u0022: \u0022string\u0022,\n \u0022path\u0022: \u0022string\u0022,\n \u0022method\u0022: \u0022string\u0022,\n \u0022reproductionCurl\u0022: \u0022string\u0022,\n \u0022guidanceId\u0022: \u0022string\u0022,\n \u0022assignedToUserId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022assignedToUserName\u0022: \u0022string\u0022,\n \u0022resolutionNotes\u0022: \u0022string\u0022,\n \u0022resolvedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022resolvedByUserId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022modifiedAt\u0022: \u00222024-01-01T00:00:00Z\u0022\n }\n ],\n \u0022total\u0022: 0,\n \u0022skip\u0022: 0,\n \u0022take\u0022: 0\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Export findings as SARIF", "description": "Returns the findings of a project as a SARIF 2.1.0 document, which GitHub code\nscanning and comparable tools ingest directly. Upload it from your pipeline and\nthe findings show up next to the code they concern. Without a \u0060status\u0060 filter it\nreturns the open ones, which is what a build gate wants.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/security/findings/export/sarif", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "security", "findings", "export", "sarif" ], "query": [ { "key": "status", "value": "", "description": "Filter by finding status. Defaults to \u0060open\u0060.", "disabled": true } ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." } ] }, "description": "Returns the findings of a project as a SARIF 2.1.0 document, which GitHub code\nscanning and comparable tools ingest directly. Upload it from your pipeline and\nthe findings show up next to the code they concern. Without a \u0060status\u0060 filter it\nreturns the open ones, which is what a build gate wants.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/sarif\u002Bjson" } ], "body": "\u0022string\u0022", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Start a security scan", "description": "Queues a scan for the given profile and returns immediately with the tracking id,\nbecause a scan runs in the background. Poll the scan run endpoint until its\nstatus leaves \u0060queued\u0060 and \u0060running\u0060.\n", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/security/scan-profiles/:profileId/run", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "security", "scan-profiles", ":profileId", "run" ], "variable": [ { "key": "profileId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the scan profile." }, { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." } ] }, "description": "Queues a scan for the given profile and returns immediately with the tracking id,\nbecause a scan runs in the background. Poll the scan run endpoint until its\nstatus leaves \u0060queued\u0060 and \u0060running\u0060.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "202 Unknown", "status": "Unknown", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022scanProfilePublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022status\u0022: \u0022queued\u0022,\n \u0022trigger\u0022: \u0022manual\u0022,\n \u0022startedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022completedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022totalChecks\u0022: 0,\n \u0022checksPassed\u0022: 0,\n \u0022checksFailed\u0022: 0,\n \u0022checksSkipped\u0022: 0,\n \u0022securityScore\u0022: 0,\n \u0022errorMessage\u0022: \u0022string\u0022,\n \u0022openFindingsCount\u0022: 0,\n \u0022enabledScannerCount\u0022: 0,\n \u0022scannersCompleted\u0022: 0,\n \u0022currentScannerId\u0022: \u0022string\u0022,\n \u0022cancelRequestedAt\u0022: \u00222024-01-01T00:00:00Z\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get a scan run", "description": "Returns the state of a scan, including how many scanners have finished and which\none is running. Once \u0060status\u0060 is \u0060completed\u0060, \u0060securityScore\u0060 and\n\u0060openFindingsCount\u0060 are final and a pipeline can gate on them.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/security/scan-runs/:runId", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "security", "scan-runs", ":runId" ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "runId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the scan run." } ] }, "description": "Returns the state of a scan, including how many scanners have finished and which\none is running. Once \u0060status\u0060 is \u0060completed\u0060, \u0060securityScore\u0060 and\n\u0060openFindingsCount\u0060 are final and a pipeline can gate on them.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022scanProfilePublicId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022status\u0022: \u0022queued\u0022,\n \u0022trigger\u0022: \u0022manual\u0022,\n \u0022startedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022completedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022totalChecks\u0022: 0,\n \u0022checksPassed\u0022: 0,\n \u0022checksFailed\u0022: 0,\n \u0022checksSkipped\u0022: 0,\n \u0022securityScore\u0022: 0,\n \u0022errorMessage\u0022: \u0022string\u0022,\n \u0022openFindingsCount\u0022: 0,\n \u0022enabledScannerCount\u0022: 0,\n \u0022scannersCompleted\u0022: 0,\n \u0022currentScannerId\u0022: \u0022string\u0022,\n \u0022cancelRequestedAt\u0022: \u00222024-01-01T00:00:00Z\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "API Specs", "item": [ { "name": "List the specifications of a project", "description": "Returns the specifications of a project together with the number of their\nlatest published version, so a pipeline can resolve a spec by name and see at a\nglance what is live.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/specs", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "specs" ], "query": [ { "key": "skip", "value": "1", "description": "Number of items to skip. Defaults to 0.", "disabled": true }, { "key": "take", "value": "1", "description": "Maximum number of items to return.", "disabled": true } ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." } ] }, "description": "Returns the specifications of a project together with the number of their\nlatest published version, so a pipeline can resolve a spec by name and see at a\nglance what is live.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022items\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022name\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022,\n \u0022openApiVersion\u0022: \u0022v3_0\u0022,\n \u0022description\u0022: \u0022string\u0022,\n \u0022basePath\u0022: \u0022string\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022modifiedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022rowVersion\u0022: \u0022string\u0022,\n \u0022latestPublishedVersion\u0022: \u0022string\u0022\n }\n ],\n \u0022totalCount\u0022: 0\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Export the current state of a specification", "description": "Returns the working state of a specification as OpenAPI, which is the draft as\nit stands in the designer right now. To export something stable, export a\npublished version instead.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/specs/:specId/export", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "specs", ":specId", "export" ], "query": [ { "key": "format", "value": "", "description": "Output format. Defaults to \u0060yaml\u0060.", "disabled": true } ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "specId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the API specification." } ] }, "description": "Returns the working state of a specification as OpenAPI, which is the draft as\nit stands in the designer right now. To export something stable, export a\npublished version instead.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\u0022string\u0022", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List the versions of a specification", "description": "Returns the versions of a specification with their status and publish target.\nOnly a version whose status is \u0060published\u0060 is frozen, so anything else can still\nchange underneath you.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/specs/:specId/versions", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "specs", ":specId", "versions" ], "query": [ { "key": "skip", "value": "1", "description": "Number of items to skip. Defaults to 0.", "disabled": true }, { "key": "take", "value": "1", "description": "Maximum number of items to return.", "disabled": true } ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "specId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the API specification." } ] }, "description": "Returns the versions of a specification with their status and publish target.\nOnly a version whose status is \u0060published\u0060 is frozen, so anything else can still\nchange underneath you.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022items\u0022: [\n {\n \u0022id\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022versionNumber\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022draft\u0022,\n \u0022createdAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022publishedAt\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022publishTarget\u0022: \u0022internal\u0022,\n \u0022rowVersion\u0022: \u0022string\u0022\n }\n ],\n \u0022totalCount\u0022: 0\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Export a published version", "description": "Returns a published version as a downloadable OpenAPI document. A published\nversion is frozen, so the same call returns the same bytes forever, which makes\nit safe to generate clients from in a build.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/api/projects/:projectId/specs/:specId/versions/:versionId/export", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "specs", ":specId", "versions", ":versionId", "export" ], "query": [ { "key": "format", "value": "", "description": "Output format. Defaults to \u0060yaml\u0060.", "disabled": true } ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "specId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the API specification." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the specification version." } ] }, "description": "Returns a published version as a downloadable OpenAPI document. A published\nversion is frozen, so the same call returns the same bytes forever, which makes\nit safe to generate clients from in a build.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\u0022string\u0022", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Record that a version went into an environment", "description": "Tells Routebase which version an environment now serves. The intended order is\nthat your pipeline deploys first and then makes this call, so the pin reflects\nwhat is actually running rather than what someone intended.\n\nA call authenticated with an API key is recorded with source \u0060cli\u0060, which is how\na pipeline assertion is told apart from someone clicking in the UI. If the target\nenvironment freezes versions, the promoted version becomes immutable here.\n", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "8e03978e-40d5-43e8-bc93-6894a57f9324", "description": "Makes a retry of this write safe. Send a new value of 1 to 255 characters for each logical request and the same value on every retry. A successful result is kept for 24 hours, and a retry within that time returns it with the \u0060Idempotency-Replayed\u0060 header instead of running the request again.", "disabled": true }, { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \u0022environmentId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022publishTarget\u0022: \u0022internal\u0022,\n \u0022impactAcknowledged\u0022: true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/projects/:projectId/specs/:specId/versions/:versionId/promote", "host": [ "{{base_url}}" ], "path": [ "api", "projects", ":projectId", "specs", ":specId", "versions", ":versionId", "promote" ], "variable": [ { "key": "projectId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the project." }, { "key": "specId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the API specification." }, { "key": "versionId", "value": "00000000-0000-0000-0000-000000000000", "description": "Public id of the specification version." } ] }, "description": "Tells Routebase which version an environment now serves. The intended order is\nthat your pipeline deploys first and then makes this call, so the pin reflects\nwhat is actually running rather than what someone intended.\n\nA call authenticated with an API key is recorded with source \u0060cli\u0060, which is how\na pipeline assertion is told apart from someone clicking in the UI. If the target\nenvironment freezes versions, the promoted version becomes immutable here.\n", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{ApiKeyAuth}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022promotionId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022environmentId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022environmentName\u0022: \u0022string\u0022,\n \u0022versionId\u0022: \u002200000000-0000-0000-0000-000000000000\u0022,\n \u0022versionNumber\u0022: \u0022string\u0022,\n \u0022frozeVersion\u0022: true,\n \u0022previousVersionNumber\u0022: \u0022string\u0022,\n \u0022source\u0022: \u0022manual\u0022,\n \u0022isRollback\u0022: true\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "401 Unauthorized", "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "403 Forbidden", "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "422 Unprocessable Entity", "status": "Unprocessable Entity", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "SCIM", "item": [ { "name": "List groups", "description": "Returns the provisioned groups of an organization in a SCIM ListResponse\nenvelope. Groups map onto Routebase teams, and a group mapping decides which\nrole its members receive.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Groups", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Groups" ], "query": [ { "key": "count", "value": "1", "description": "Maximum number of results per page. Defaults to 100.", "disabled": true }, { "key": "filter", "value": "", "description": "SCIM filter expression, for example \u0060displayName eq \u0022Engineering\u0022\u0060.", "disabled": true }, { "key": "startIndex", "value": "1", "description": "1-based index of the first result. Defaults to 1.", "disabled": true } ], "variable": [ { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Returns the provisioned groups of an organization in a SCIM ListResponse\nenvelope. Groups map onto Routebase teams, and a group mapping decides which\nrole its members receive.\n", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022totalResults\u0022: 0,\n \u0022startIndex\u0022: 0,\n \u0022itemsPerPage\u0022: 0,\n \u0022Resources\u0022: [\n {\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022displayName\u0022: \u0022string\u0022,\n \u0022members\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022display\u0022: \u0022string\u0022,\n \u0022$ref\u0022: \u0022string\u0022,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Provision a group", "description": "Creates a group and adds the members you send with it.", "request": { "method": "POST", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true }, { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": { "mode": "raw", "raw": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022displayName\u0022: \u0022string\u0022,\n \u0022members\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022display\u0022: \u0022string\u0022,\n \u0022$ref\u0022: \u0022string\u0022,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Groups", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Groups" ], "variable": [ { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Creates a group and adds the members you send with it.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "201 Created", "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022displayName\u0022: \u0022string\u0022,\n \u0022members\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022display\u0022: \u0022string\u0022,\n \u0022$ref\u0022: \u0022string\u0022,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get a group", "description": "Returns one provisioned group with its members.", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Groups/:id", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "SCIM id of the resource." }, { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Returns one provisioned group with its members.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022displayName\u0022: \u0022string\u0022,\n \u0022members\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022display\u0022: \u0022string\u0022,\n \u0022$ref\u0022: \u0022string\u0022,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Patch a group", "description": "Applies a SCIM PatchOp to a group, which is how an identity provider adds and\nremoves members as people join and leave a team.\n", "request": { "method": "PATCH", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true }, { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": { "mode": "raw", "raw": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022Operations\u0022: [\n {\n \u0022op\u0022: \u0022add\u0022,\n \u0022path\u0022: \u0022string\u0022\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Groups/:id", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "SCIM id of the resource." }, { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Applies a SCIM PatchOp to a group, which is how an identity provider adds and\nremoves members as people join and leave a team.\n", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022displayName\u0022: \u0022string\u0022,\n \u0022members\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022display\u0022: \u0022string\u0022,\n \u0022$ref\u0022: \u0022string\u0022,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Deprovision a group", "description": "Removes a group. Its members keep their organization membership.", "request": { "method": "DELETE", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Groups/:id", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "SCIM id of the resource." }, { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Removes a group. Its members keep their organization membership.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "204 No Content", "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ] }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List the supported resource types", "description": "Returns the SCIM resource types this service exposes, which are User and Group.", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/ResourceTypes", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "ResourceTypes" ], "variable": [ { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Returns the SCIM resource types this service exposes, which are User and Group.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List the supported schemas", "description": "Returns the SCIM schemas backing the User and Group resources.", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Schemas", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Schemas" ], "variable": [ { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Returns the SCIM schemas backing the User and Group resources.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Describe what this SCIM service supports", "description": "Returns the SCIM service provider configuration, which identity providers read\nduring setup to learn which operations are available.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/ServiceProviderConfig", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "ServiceProviderConfig" ], "variable": [ { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Returns the SCIM service provider configuration, which identity providers read\nduring setup to learn which operations are available.\n", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List users", "description": "Returns the provisioned users of an organization in a SCIM ListResponse\nenvelope. Identity providers use the \u0060filter\u0060 parameter to look a user up by\n\u0060userName\u0060 before deciding whether to create or update.\n", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Users", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Users" ], "query": [ { "key": "count", "value": "1", "description": "Maximum number of results per page. Defaults to 100.", "disabled": true }, { "key": "filter", "value": "", "description": "SCIM filter expression, for example \u0060userName eq \u0022ada@example.com\u0022\u0060.", "disabled": true }, { "key": "startIndex", "value": "1", "description": "1-based index of the first result. Defaults to 1.", "disabled": true } ], "variable": [ { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Returns the provisioned users of an organization in a SCIM ListResponse\nenvelope. Identity providers use the \u0060filter\u0060 parameter to look a user up by\n\u0060userName\u0060 before deciding whether to create or update.\n", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022totalResults\u0022: 0,\n \u0022startIndex\u0022: 0,\n \u0022itemsPerPage\u0022: 0,\n \u0022Resources\u0022: [\n {\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022userName\u0022: \u0022string\u0022,\n \u0022name\u0022: {\n \u0022givenName\u0022: \u0022string\u0022,\n \u0022familyName\u0022: \u0022string\u0022,\n \u0022formatted\u0022: \u0022string\u0022\n },\n \u0022emails\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022primary\u0022: true,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022active\u0022: true,\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n }\n ]\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Provision a user", "description": "Creates a user in the organization. A user provisioned this way joins with the\ndefault member role, and further role changes stay with Routebase rather than\nthe identity provider.\n", "request": { "method": "POST", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true }, { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": { "mode": "raw", "raw": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022userName\u0022: \u0022string\u0022,\n \u0022name\u0022: {\n \u0022givenName\u0022: \u0022string\u0022,\n \u0022familyName\u0022: \u0022string\u0022,\n \u0022formatted\u0022: \u0022string\u0022\n },\n \u0022emails\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022primary\u0022: true,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022active\u0022: true,\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Users", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Users" ], "variable": [ { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Creates a user in the organization. A user provisioned this way joins with the\ndefault member role, and further role changes stay with Routebase rather than\nthe identity provider.\n", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "201 Created", "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022userName\u0022: \u0022string\u0022,\n \u0022name\u0022: {\n \u0022givenName\u0022: \u0022string\u0022,\n \u0022familyName\u0022: \u0022string\u0022,\n \u0022formatted\u0022: \u0022string\u0022\n },\n \u0022emails\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022primary\u0022: true,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022active\u0022: true,\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "409 Conflict", "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get a user", "description": "Returns one provisioned user.", "request": { "method": "GET", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Users/:id", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "SCIM id of the resource." }, { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Returns one provisioned user.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022userName\u0022: \u0022string\u0022,\n \u0022name\u0022: {\n \u0022givenName\u0022: \u0022string\u0022,\n \u0022familyName\u0022: \u0022string\u0022,\n \u0022formatted\u0022: \u0022string\u0022\n },\n \u0022emails\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022primary\u0022: true,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022active\u0022: true,\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Replace a user", "description": "Replaces the attributes of a user wholesale. Attributes you leave out are\ncleared, so send the complete resource rather than a partial one.\n", "request": { "method": "PUT", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true }, { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": { "mode": "raw", "raw": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022userName\u0022: \u0022string\u0022,\n \u0022name\u0022: {\n \u0022givenName\u0022: \u0022string\u0022,\n \u0022familyName\u0022: \u0022string\u0022,\n \u0022formatted\u0022: \u0022string\u0022\n },\n \u0022emails\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022primary\u0022: true,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022active\u0022: true,\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Users/:id", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "SCIM id of the resource." }, { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Replaces the attributes of a user wholesale. Attributes you leave out are\ncleared, so send the complete resource rather than a partial one.\n", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022userName\u0022: \u0022string\u0022,\n \u0022name\u0022: {\n \u0022givenName\u0022: \u0022string\u0022,\n \u0022familyName\u0022: \u0022string\u0022,\n \u0022formatted\u0022: \u0022string\u0022\n },\n \u0022emails\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022primary\u0022: true,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022active\u0022: true,\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Patch a user", "description": "Applies a SCIM PatchOp to a user. This is the call an identity provider makes to\ndeactivate someone, by setting \u0060active\u0060 to false, which is a soft removal that\nkeeps the audit trail intact.\n", "request": { "method": "PATCH", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true }, { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": { "mode": "raw", "raw": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022Operations\u0022: [\n {\n \u0022op\u0022: \u0022add\u0022,\n \u0022path\u0022: \u0022string\u0022\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Users/:id", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "SCIM id of the resource." }, { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Applies a SCIM PatchOp to a user. This is the call an identity provider makes to\ndeactivate someone, by setting \u0060active\u0060 to false, which is a soft removal that\nkeeps the audit trail intact.\n", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022id\u0022: \u0022string\u0022,\n \u0022externalId\u0022: \u0022string\u0022,\n \u0022userName\u0022: \u0022string\u0022,\n \u0022name\u0022: {\n \u0022givenName\u0022: \u0022string\u0022,\n \u0022familyName\u0022: \u0022string\u0022,\n \u0022formatted\u0022: \u0022string\u0022\n },\n \u0022emails\u0022: [\n {\n \u0022value\u0022: \u0022string\u0022,\n \u0022primary\u0022: true,\n \u0022type\u0022: \u0022string\u0022\n }\n ],\n \u0022active\u0022: true,\n \u0022meta\u0022: {\n \u0022resourceType\u0022: \u0022string\u0022,\n \u0022created\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022lastModified\u0022: \u00222024-01-01T00:00:00Z\u0022,\n \u0022location\u0022: \u0022string\u0022,\n \u0022version\u0022: \u0022string\u0022\n }\n}", "_postman_previewlanguage": "json" }, { "name": "400 Bad Request", "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Deprovision a user", "description": "Removes a user from the organization.", "request": { "method": "DELETE", "header": [ { "key": "X-RB-Region", "value": "us", "description": "Region of your organization. US organizations must send \u0060us\u0060; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.", "disabled": true } ], "url": { "raw": "{{base_url}}/scim/v2/:orgSlug/Users/:id", "host": [ "{{base_url}}" ], "path": [ "scim", "v2", ":orgSlug", "Users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000", "description": "SCIM id of the resource." }, { "key": "orgSlug", "value": "", "description": "Slug of the organization, as shown in Settings." } ] }, "description": "Removes a user from the organization.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ScimBearerAuth}}", "type": "string" } ] } }, "response": [ { "name": "204 No Content", "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ] }, { "name": "404 Not Found", "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/scim\u002Bjson" } ], "body": "{\n \u0022schemas\u0022: [\n \u0022string\u0022\n ],\n \u0022detail\u0022: \u0022string\u0022,\n \u0022status\u0022: \u0022string\u0022,\n \u0022scimType\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" }, { "name": "429 Unknown", "status": "Unknown", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem\u002Bjson" } ], "body": "{\n \u0022type\u0022: \u0022string\u0022,\n \u0022title\u0022: \u0022string\u0022,\n \u0022status\u0022: 0,\n \u0022detail\u0022: \u0022string\u0022,\n \u0022instance\u0022: \u0022string\u0022,\n \u0022code\u0022: \u0022string\u0022\n}", "_postman_previewlanguage": "json" } ] } ] } ], "variable": [ { "key": "base_url", "value": "https://api.routebase.dev", "type": "string", "description": "Base URL for API requests" }, { "key": "ApiKeyAuth", "value": "", "type": "string" }, { "key": "ScimBearerAuth", "value": "", "type": "string" } ] }