{"items":[{"type":"link","label":"Redocly platform","link":"/docs/platform/customization/reunite-api/openapi","routeSlug":"/docs/platform/customization/reunite-api/openapi","content":{"contentType":"overview","meta":{"name":"Redocly platform"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/docs/platform/customization/reunite-api/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/docs/platform/customization/reunite-api/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://github.com/Redocly/redocly","url":"https://github.com/Redocly/redocly"},{"kind":"email","title":"API Support","email":"team@redocly.com","label":"team@redocly.com","withCopyButton":true,"copyContent":"team@redocly.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Redocly","url":"https://redocly.com/subscription-agreement"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://redocly.com/subscription-agreement"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Redocly platform (1.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redocly platform API is a REST API over HTTPS for accessing and managing Redocly platform resources."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API supports the following use cases:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Automation of organization and project workflows"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integration with internal systems"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Development of customer-facing integrations"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Technical characteristics:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Resource-oriented URLs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["JSON request and response bodies"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Standard HTTP methods and status codes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Filtering and search on selected collection endpoints"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint availability depends on subscription plan, organization settings, and product rollout status."," ","The API description is the authoritative reference."," ","Organizations for which an endpoint is not enabled should contact support."]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"section/authentication","level":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API uses API keys for authentication."," ","Authentication requirements are defined per operation in the API description."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API keys are intended for server-to-server integration."," ","API keys are created as described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://redocly.com/docs/platform/organization/api-keys"},"children":["Manage API keys"]},"."," ","The key is transmitted as a Bearer token:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"Authorization: Bearer <api_key>\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keys must meet the following requirements:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stored in a secure secret management system (not in client-side application code)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rotated on a regular basis"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Revoked when no longer required"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Limited to the minimum set of endpoints and environments necessary for the integration"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every operation states the authentication it accepts in its own ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["security"]}," section."," ","Typical responses include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}," (missing, invalid, or expired credentials)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}," (credentials are valid but insufficient for the requested action)"]}]}]}],"sectionId":"/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"section/pagination","level":2},"children":["Pagination"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List endpoints implement cursor-based pagination."," ","Each response includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," object and the results in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," array."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported query parameters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]},": values from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},", default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]},": cursor navigation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]},": for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-id"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," object contains:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPage"]},": the path of the next page, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," when there is no next page"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previousPage"]},": the path of the previous page, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," when there is no previous page"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPage"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previousPage"]}," are paths relative to the API server URL."," ","They keep the query parameters of the request, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]},"."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPage"]}," sets ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," to the cursor of the next page, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previousPage"]}," sets ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]}," to the cursor of the previous page."," ","To get the adjacent page, append the value to the server URL as a string:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"https://app.cloud.redocly.com/api + /orgs/org_123/projects?limit=10&after=a25fgaksjf23la==\n= https://app.cloud.redocly.com/api/orgs/org_123/projects?limit=10&after=a25fgaksjf23la==\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not resolve the value as a relative URL, for example with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["new URL(nextPage, serverUrl)"]},"."," ","The leading ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/"]}," replaces the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api"]}," path of the server URL."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A typical sequence:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request the first page with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?limit=10"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request the server URL followed by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Continue until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPage"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The cursors are opaque, and their internal structure is subject to change."," ","To build a request yourself, send the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," value from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPage"]},", or the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]}," value from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previousPage"]},", with your other query parameters."]}]}],"sectionId":"/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"section/filter-results","level":2},"children":["Filter results"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filtering"]}," uses the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter="]}," parameter with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field:value"]}," syntax."," ","The supported forms include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Exact match: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName:Casey"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Case-insensitive substring match: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName~jo"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Multiple values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName:Casey,Jordan"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status:success,pending"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Numeric or date-time ranges: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount:1..10"]},", ISO 8601 date-times"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Relative durations for date-time fields: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["30d"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2w"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6mo"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1y"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["all"]}," (units: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["s"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["m"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["h"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["d"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["w"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mo"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["y"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Nested fields: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["team.user.email:casey.smith@acme-inc.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Negation: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-firstName:Casey"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Logical operators: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OR"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Combine multiple conditions by separating ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field:value"]}," pairs with a space."," ","A space is treated as an implicit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AND"]},", so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName:Casey isAdmin:true"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName:Casey AND isAdmin:true"]}," are equivalent."," ","Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OR"]}," to match alternatives."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AND"]}," binds more tightly than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OR"]},", so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role:admin OR role:editor isActive:true"]}," is evaluated as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role:admin OR (role:editor AND isActive:true)"]},"."," ","Grouping with parentheses is not supported."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a single-valued field, comma-separated values and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OR"]}," are equivalent: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role:admin,editor"]}," matches the same records as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role:admin OR role:editor"]},"."," ","They are not interchangeable when the field targets a to-many relation, when negation is applied (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-role:admin,editor"]}," matches neither value, whereas ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-role:admin OR -role:editor"]}," matches every record), or when matching ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Explicit date-time values use ISO 8601."," ","Values that contain spaces, commas, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".."]}," must be enclosed in quotation marks."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," values do not require quotation marks."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"?filter=firstName:Casey\n?filter=firstName~jo\n?filter=firstName:Casey,Jordan\n?filter=amount:1..10\n?filter=createdAt:30d\n?filter=team.user.email:casey.smith@acme-inc.com\n?filter=-firstName:Casey\n?filter=firstName:Casey isAdmin:true\n?filter=firstName:Casey AND isAdmin:true\n?filter=role:admin OR role:editor\n?filter=createdAt:2021-02-14T13:30:00.000Z\n?filter=description:\"The story called \\\"The Sky and the Sea.\\\"\"\n?search=casey\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search"]}," uses the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?search="]}," parameter where the operation supports it."," ","Its behavior is defined per endpoint in the API description."]}]}],"sectionId":"/section/filter-results"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"section/errors","level":2},"children":["Errors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Error responses commonly use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/problem+json"]}," media type."," ","Fields may include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}," (optional)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instance"]}," (optional)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object"]}," (always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["problem"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestId"]}," (optional)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," (optional array)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Frequently returned HTTP status codes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},": validation failure or malformed input"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},": authentication failure"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},": authorization failure"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},": resource not found"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]},": conflict with current state"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]},": rate limit exceeded"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]},": server error"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Additional behavior:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Certain endpoints may return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["402"]}," when access depends on subscription plan or billing state."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Troubleshooting:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Begin with the HTTP status code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Review the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," fields."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include the following in support requests:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The complete response payload"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sufficient request context to reproduce the issue"]}]}]}],"sectionId":"/section/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"section/rate-limits","level":2},"children":["Rate limits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rate limiting preserves service stability and equitable usage."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API description defines limits with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-rateLimit"]}," extension."," ","These organization quotas apply to requests authenticated with an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API key"]}," that belongs to your organization."," ","Example properties:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["events"]}," - the number of events allowed within the window"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["window"]}," - the length of the window, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1m"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enforcement:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For API keys, limits apply ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["per organization"]},": all API keys for the same organization share a single counter for a given limit."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Unauthenticated traffic to public endpoints does ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," consume these organization counters."," ","It is limited separately (for example by per-client protections at the edge)."," ","This mechanism prevents anonymous callers from exhausting an organization's quota."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Limits may be defined per endpoint."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Limits may be overridden per organization or per endpoint."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a request exceeds the applicable limit, the API returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429 Too Many Requests"]}," and includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header with the number of seconds to wait before the next request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send requests for increased throughput to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["team@redocly.com"]}," and include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Organization ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Affected endpoints"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Expected request rate"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Business justification"]}]}]}],"sectionId":"/section/rate-limits"}]}]}},{"type":"link","label":"Authentication","link":"/docs/platform/customization/reunite-api/openapi/section/authentication","routeSlug":"/docs/platform/customization/reunite-api/openapi/section/authentication","content":null},{"type":"link","label":"Pagination","link":"/docs/platform/customization/reunite-api/openapi/section/pagination","routeSlug":"/docs/platform/customization/reunite-api/openapi/section/pagination","content":null},{"type":"link","label":"Filter results","link":"/docs/platform/customization/reunite-api/openapi/section/filter-results","routeSlug":"/docs/platform/customization/reunite-api/openapi/section/filter-results","content":null},{"type":"link","label":"Errors","link":"/docs/platform/customization/reunite-api/openapi/section/errors","routeSlug":"/docs/platform/customization/reunite-api/openapi/section/errors","content":null},{"type":"link","label":"Rate limits","link":"/docs/platform/customization/reunite-api/openapi/section/rate-limits","routeSlug":"/docs/platform/customization/reunite-api/openapi/section/rate-limits","content":null},{"type":"group","label":"Audit log exports","link":"/docs/platform/customization/reunite-api/openapi/audit-log-exports","routeSlug":"/docs/platform/customization/reunite-api/openapi/audit-log-exports","items":[{"label":"Start an audit log export job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/audit-log-exports/createauditlogexportjob","routeSlug":"/docs/platform/customization/reunite-api/openapi/audit-log-exports/createauditlogexportjob","metadata":{"seo":{"title":"Start an audit log export job","description":"Start an audit log export job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAuditLogExportJob","name":"Start an audit log export job","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Start an audit log export job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"plans":["Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates an asynchronous audit log export job."," ","Poll the job status endpoint until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPLETED"]},", then download from the export results endpoint."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Standard list ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}," query. Supported fields for audit exports:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," — Event type."," ","When omitted, exports include events of all types."," ","Values must be valid audit log event types."," ","Unsupported values return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Filter fields other than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," are ignored."]}]},"example":"type:com.redocly.apiKey.created"},{"name":"start","in":"query","schemaId":"schema_2","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start of the time range in YYYY-MM-DD format. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]}," is omitted, exports include events from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}," through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start + 31 days"]},"."]}]},"example":"2026-01-01"},{"name":"end","in":"query","schemaId":"schema_2","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["End of the time range in YYYY-MM-DD format. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}," is omitted, exports include events from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end - 31 days"]}," through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},". The time window between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]}," must not exceed 31 days."]}]},"example":"2026-01-31"},{"name":"format","in":"query","schemaId":"schema_3","description":"Output file format for the generated download.","example":"json"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/audit-log-export-jobs","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"}],"query":[{"name":"filter","in":"query","required":false,"example":"type:com.redocly.apiKey.created","schemaId":"schema_1"},{"name":"start","in":"query","required":false,"example":"2026-01-01","schemaId":"schema_2"},{"name":"end","in":"query","required":false,"example":"2026-01-31","schemaId":"schema_2"},{"name":"format","in":"query","required":false,"example":"json","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/orgs/{orgId}/audit-log-export-jobs","href":"audit-log-exports/createauditlogexportjob","openApiOperationId":"createAuditLogExportJob","summary":"Start an audit log export job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Export job created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditLogExportJobCreated","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/AuditLogExportJobCreated","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/AuditLogExportJobCreated","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditLogExportJobCreated","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-log-exports/createauditlogexportjob"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/audit-log-export-jobs"},{"label":"Retrieve an audit log export job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/audit-log-exports/getauditlogexportjob","routeSlug":"/docs/platform/customization/reunite-api/openapi/audit-log-exports/getauditlogexportjob","metadata":{"seo":{"title":"Retrieve an audit log export job","description":"Retrieve an audit log export job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditLogExportJob","name":"Retrieve an audit log export job","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Retrieve an audit log export job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"plans":["Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve the status of an audit log export job."," ","Poll this endpoint until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPLETED"]},", then download the file from the export results endpoint."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"exportJobId","in":"path","schemaId":"schema_6","description":"Export Job ID.","required":true,"example":"exp_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/audit-log-export-jobs/{exportJobId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"exportJobId","in":"path","required":true,"example":"exp_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/orgs/{orgId}/audit-log-export-jobs/{exportJobId}","href":"audit-log-exports/getauditlogexportjob","openApiOperationId":"getAuditLogExportJob","summary":"Retrieve an audit log export job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Export job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditLogExportJob","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AuditLogExportJob","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditLogExportJob","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditLogExportJob","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-log-exports/getauditlogexportjob"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/audit-log-export-jobs/{exportJobId}"},{"label":"Retrieve an audit log export file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/audit-log-exports/getauditlogexportresult","routeSlug":"/docs/platform/customization/reunite-api/openapi/audit-log-exports/getauditlogexportresult","metadata":{"seo":{"title":"Retrieve an audit log export file","description":"Retrieve an audit log export file"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditLogExportResult","name":"Retrieve an audit log export file","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Retrieve an audit log export file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"plans":["Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Download the file generated by an audit log export job."," ","The file is available only after the export job completes."," ","While the job status is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN_PROGRESS"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILED"]},", this endpoint returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},"."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"exportJobId","in":"path","schemaId":"schema_6","description":"Export Job ID.","required":true,"example":"exp_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/audit-log-export-results/{exportJobId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"exportJobId","in":"path","required":true,"example":"exp_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/orgs/{orgId}/audit-log-export-results/{exportJobId}","href":"audit-log-exports/getauditlogexportresult","openApiOperationId":"getAuditLogExportResult","summary":"Retrieve an audit log export file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Export file. Media type matches the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}," from the create-job request."]}]},"mediaType":"application/json","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/application~1json/example"]},"text/csv":{"schemaId":"schema_8","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/text~1csv/example"]}},"schemaId":"schema_7","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/application~1json/example"],"headers":{"Content-Disposition":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Attachment hint for browsers and HTTP clients. Suggested filename: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{exportJobId}.json"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{exportJobId}.csv"]},"."]}]},"schema":{"type":"string"},"example":"attachment; filename=\"exp_01hh1t9sa6gwfv5naz04gr7ehm.json\""}},"headerSchemaId":"schema_9"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_7","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/application~1json/example"]},"text/csv":{"schemaId":"schema_8","exampleIds":["paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/text~1csv/example"]}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-log-exports/getauditlogexportresult"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/audit-log-export-results/{exportJobId}"}],"content":{"contentType":"group","meta":{"name":"Audit log exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit log exports","showPageActions":true},{"nodeType":"markdoc","content":"Export organization audit logs for compliance, analysis, or archival."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/audit-log-export-jobs","summary":"Start an audit log export job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-log-exports/createauditlogexportjob","deprecated":false},{"title":"/orgs/{orgId}/audit-log-export-jobs/{exportJobId}","summary":"Retrieve an audit log export job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-log-exports/getauditlogexportjob","deprecated":false},{"title":"/orgs/{orgId}/audit-log-export-results/{exportJobId}","summary":"Retrieve an audit log export file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-log-exports/getauditlogexportresult","deprecated":false}]}]}]}]}},{"type":"group","label":"Credentials","link":"/docs/platform/customization/reunite-api/openapi/credentials","routeSlug":"/docs/platform/customization/reunite-api/openapi/credentials","items":[{"label":"Create a credential rotation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/credentials/createcredentialrotation","routeSlug":"/docs/platform/customization/reunite-api/openapi/credentials/createcredentialrotation","metadata":{"seo":{"title":"Create a credential rotation","description":"Replaces the access token of a shared GitLab, Azure DevOps, or Bitbucket token credential.Redocly validates the new token with the Git provider before saving it.Rotating any other credential type returns 400."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCredentialRotation","name":"Create a credential rotation","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1credential-rotations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Create a credential rotation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replaces the access token of a shared GitLab, Azure DevOps, or Bitbucket token credential."," ","Redocly validates the new token with the Git provider before saving it."," ","Rotating any other credential type returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To find the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credentialId"]},", list the sources or remotes of the project that uses the credential."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only shared credentials can be rotated with an API key. Personal credentials return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},"."," ","Use an API key with granular permissions that include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org.credentials.update"]},", or a legacy full access key."," ","API keys with RBAC permissions return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After saving the token, Redocly sets up webhooks again for the repositories that use the credential."," ","Repositories where the webhook setup fails are listed in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warnings"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org.credentials.update"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1credential-rotations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1credential-rotations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCredentialRotationRequest"}},"schemaId":"components/schemas/CreateCredentialRotationRequest","pointer":"/paths/~1orgs~1{orgId}~1credential-rotations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/credential-rotations","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCredentialRotationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orgs/{orgId}/credential-rotations","href":"credentials/createcredentialrotation","openApiOperationId":"createCredentialRotation","summary":"Create a credential rotation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"schemaId":"components/schemas/CreateCredentialRotationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCredentialRotationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credential access token replaced.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CredentialPatchResponse"}},"schemaId":"components/schemas/CredentialPatchResponse"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1credential-rotations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CredentialPatchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CredentialPatchResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/createcredentialrotation"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/credential-rotations"}],"content":{"contentType":"group","meta":{"name":"Credentials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credentials","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to credentials."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/credential-rotations","summary":"Create a credential rotation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credentials/createcredentialrotation","deprecated":false}]}]}]}]}},{"type":"group","label":"Feedback","link":"/docs/platform/customization/reunite-api/openapi/feedback","routeSlug":"/docs/platform/customization/reunite-api/openapi/feedback","items":[{"label":"List all feedback","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/feedback/listfeedback","routeSlug":"/docs/platform/customization/reunite-api/openapi/feedback/listfeedback","metadata":{"seo":{"title":"List all feedback","description":"List all feedback."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedback","name":"List all feedback","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"List all feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all feedback."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.feedback.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the next page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"a25fgaksjf23la=="},{"name":"before","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the previous page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"bfg23aksjf23zb1=="},{"name":"limit","in":"query","schemaId":"schema_11","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use to return a number of results per page."," ","If there is more data, use in combination with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," to page through the data."]}]},"example":10},{"name":"sort","in":"query","schemaId":"schema_12","description":"Feedback list can be sorted by the following properties:\n  - `id`\n  - `createdAt`\n  - `path`\n  - `email`\n  - `score`\n  - `agent`\n  - `targetFeature`\n\nTo sort in descending order, prefix the field with `-` (for example `-createdAt`).\nTo sort in ascending order, use the field name without a prefix (for example `createdAt`).\n\nBy default, feedback list is sorted by `id` in descending order, which corresponds to the newest feedback first.","example":"-id"},{"name":"filter","in":"query","schemaId":"schema_1","description":"Filter feedback by:\n  - `createdAt`\n  - `email`\n  - `path`\n  - `location`\n  - `comment`\n  - `internalComment`\n  - `agent`\n  - `targetFeature`\n  - `status` (one of `NEW`, `IN_REVIEW`, `RESOLVED`, `ARCHIVED`, `SPAM`)\n  - `feedbackComponent` (one of `SENTIMENT`, `RATING`, `COMMENT`, `MOOD`, `PROBLEM`, `SCALE`)\n  - `origin` (one of `FORM`, `API`, `MCP`)\n\nThis field requires a special format.\n\nFor more information, see [Filter results](#section/filter-results).","example":"status:approved createdAt:30d"},{"name":"search","in":"query","schemaId":"schema_1","description":"Search feedback by query string.\n\nFeedback is searched by:\n  - `email`\n  - `path`\n  - `location`\n  - `comment`\n  - `internalComment`\n  - `agent`\n  - `targetFeature`","example":"text-to-search"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/feedback","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"}],"query":[{"name":"after","in":"query","required":false,"example":"a25fgaksjf23la==","schemaId":"schema_1"},{"name":"before","in":"query","required":false,"example":"bfg23aksjf23zb1==","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_11"},{"name":"sort","in":"query","required":false,"example":"-id","schemaId":"schema_12"},{"name":"filter","in":"query","required":false,"example":"status:approved createdAt:30d","schemaId":"schema_1"},{"name":"search","in":"query","required":false,"example":"text-to-search","schemaId":"schema_1"}],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/feedback","href":"feedback/listfeedback","openApiOperationId":"listFeedback","summary":"List all feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FeedbackList"}},"schemaId":"components/schemas/FeedbackList"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FeedbackList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FeedbackList"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/listfeedback"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/feedback"},{"label":"Retrieve a feedback item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/feedback/getfeedback","routeSlug":"/docs/platform/customization/reunite-api/openapi/feedback/getfeedback","metadata":{"seo":{"title":"Retrieve a feedback item","description":"Retrieve a feedback item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeedback","name":"Retrieve a feedback item","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Retrieve a feedback item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve a feedback item."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.feedback.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"},{"name":"feedbackId","in":"path","schemaId":"schema_13","description":"Feedback ID.","required":true,"example":"fb_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"},{"name":"feedbackId","in":"path","required":true,"example":"fb_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_13"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","href":"feedback/getfeedback","openApiOperationId":"getFeedback","summary":"Retrieve a feedback item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Feedback"}},"schemaId":"components/schemas/Feedback"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Feedback","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Feedback"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/getfeedback"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}"},{"label":"Partially update a feedback item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/feedback/updatefeedback","routeSlug":"/docs/platform/customization/reunite-api/openapi/feedback/updatefeedback","metadata":{"seo":{"title":"Partially update a feedback item","description":"Partially update a feedback item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFeedback","name":"Partially update a feedback item","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Partially update a feedback item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Partially update a feedback item."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.feedback.update"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"},{"name":"feedbackId","in":"path","schemaId":"schema_13","description":"Feedback ID.","required":true,"example":"fb_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchFeedbackRequest"}},"schemaId":"components/schemas/PatchFeedbackRequest","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"},{"name":"feedbackId","in":"path","required":true,"example":"fb_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_13"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchFeedbackRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","href":"feedback/updatefeedback","openApiOperationId":"updateFeedback","summary":"Partially update a feedback item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"schemaId":"components/schemas/PatchFeedbackRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchFeedbackRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Feedback"}},"schemaId":"components/schemas/Feedback"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Feedback","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Feedback"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/updatefeedback"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}"},{"label":"Delete a feedback item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/feedback/deletefeedback","routeSlug":"/docs/platform/customization/reunite-api/openapi/feedback/deletefeedback","metadata":{"seo":{"title":"Delete a feedback item","description":"Delete a feedback item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFeedback","name":"Delete a feedback item","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Delete a feedback item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delete a feedback item."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.feedback.delete"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"},{"name":"feedbackId","in":"path","schemaId":"schema_13","description":"Feedback ID.","required":true,"example":"fb_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"},{"name":"feedbackId","in":"path","required":true,"example":"fb_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_13"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","href":"feedback/deletefeedback","openApiOperationId":"deleteFeedback","summary":"Delete a feedback item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content."},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback~1{feedbackId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/deletefeedback"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}"},{"label":"Export feedback report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/feedback/exportfeedbackreport","routeSlug":"/docs/platform/customization/reunite-api/openapi/feedback/exportfeedbackreport","metadata":{"seo":{"title":"Export feedback report","description":"Download a feedback report as CSV or JSON file.Response Content-Type is text/csv when format=csv and application/json when format=json."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportFeedbackReport","name":"Export feedback report","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback-export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Export feedback report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Download a feedback report as CSV or JSON file."," ","Response Content-Type is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]}," when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format=csv"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}," when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format=json"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.feedback.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback-export/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"format","in":"query","schemaId":"schema_14","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Export file format. Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["csv"]},"."]}]},"example":"csv"},{"name":"after","in":"query","schemaId":"schema_1","description":"Cursor from `page.nextPage` in a **List all feedback** response.\nThe export includes only the rows after this cursor.","example":"a25fgaksjf23la=="},{"name":"before","in":"query","schemaId":"schema_1","description":"Cursor from `page.previousPage` in a **List all feedback** response.\nThe export includes only the rows before this cursor.","example":"bfg23aksjf23zb1=="},{"name":"limit","in":"query","schemaId":"schema_15","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Maximum number of feedback rows to include in the export (from the current sort order)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When omitted, the export includes up to 1000 rows."," ","Request a larger export explicitly, up to the maximum."]}]},"example":10000},{"name":"sort","in":"query","schemaId":"schema_12","description":"Feedback report can be sorted by the following properties:\n  - `id`\n  - `createdAt`\n  - `path`\n  - `email`\n  - `score`\n  - `agent`\n  - `targetFeature`\n\nTo sort in descending order, prefix the field with `-` (for example `-createdAt`).\nTo sort in ascending order, use the field name without a prefix (for example `createdAt`).\n\nBy default, feedback report is sorted by `id` in descending order, which corresponds to the newest feedback first.","example":"-id"},{"name":"filter","in":"query","schemaId":"schema_1","description":"Filter feedback by:\n  - `createdAt`\n  - `email`\n  - `path`\n  - `location`\n  - `comment`\n  - `internalComment`\n  - `agent`\n  - `targetFeature`\n  - `status` (one of `NEW`, `IN_REVIEW`, `RESOLVED`, `ARCHIVED`, `SPAM`)\n  - `feedbackComponent` (one of `SENTIMENT`, `RATING`, `COMMENT`, `MOOD`, `PROBLEM`, `SCALE`)\n  - `origin` (one of `FORM`, `API`, `MCP`)\n\nThis field requires a special format.\n\nFor more information, see [Filter results](#section/filter-results).","example":"status:approved createdAt:30d"},{"name":"search","in":"query","schemaId":"schema_1","description":"Search feedback by query string.\n\nFeedback is searched by:\n  - `email`\n  - `path`\n  - `location`\n  - `comment`\n  - `internalComment`\n  - `agent`\n  - `targetFeature`","example":"text-to-search"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback-export/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback-export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/feedback-export","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"}],"query":[{"name":"format","in":"query","required":false,"example":"csv","schemaId":"schema_14"},{"name":"after","in":"query","required":false,"example":"a25fgaksjf23la==","schemaId":"schema_1"},{"name":"before","in":"query","required":false,"example":"bfg23aksjf23zb1==","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":10000,"schemaId":"schema_15"},{"name":"sort","in":"query","required":false,"example":"-id","schemaId":"schema_12"},{"name":"filter","in":"query","required":false,"example":"status:approved createdAt:30d","schemaId":"schema_1"},{"name":"search","in":"query","required":false,"example":"text-to-search","schemaId":"schema_1"}],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/feedback-export","href":"feedback/exportfeedbackreport","openApiOperationId":"exportFeedbackReport","summary":"Export feedback report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Export file."," ","Media type depends on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}," query parameter."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each CSV row or JSON item has the fields of a feedback item in a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["List all feedback"]}," response."," ","In CSV, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," is a JSON string."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response is sent as a download: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Disposition"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachment"]}," with a generated filename unless the server chooses otherwise."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Default filename pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["feedback_export_{orgId}_{projectId}_{timestamp}.{format}"]},", where ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{timestamp}"]}," is milliseconds since the Unix epoch and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{format}"]}," is either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["csv"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["json"]},"."]}]},"mediaType":"text/csv","mediaTypes":["text/csv","application/json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_8"},"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8","headers":{"Content-Disposition":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Attachment hint for browsers and HTTP clients."," ","Includes the suggested filename in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filename"]}," parameter (quoted)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default the filename follows ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["feedback_export_{orgId}_{projectId}_{timestamp}.{format}"]},", using the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orgId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectId"]}," as in the path and a millisecond timestamp."]}]},"schema":{"type":"string"},"example":"attachment; filename=\"feedback_export_org_01hh1t9sa6gwfv5naz04gr7ehm_prj_01hh1t9sa6gwfv5naz04gr7ehm_1715432100123.csv\""}},"headerSchemaId":"schema_16"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1feedback-export/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_8","mediaTypes":["text/csv","application/json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_8"},"application/json":{"schemaId":"schema_8"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/exportfeedbackreport"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/feedback-export"}],"content":{"contentType":"group","meta":{"name":"Feedback"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Feedback","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to feedback."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/feedback","summary":"List all feedback","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feedback/listfeedback","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","summary":"Retrieve a feedback item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feedback/getfeedback","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","summary":"Partially update a feedback item","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/feedback/updatefeedback","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/feedback/{feedbackId}","summary":"Delete a feedback item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/feedback/deletefeedback","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/feedback-export","summary":"Export feedback report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feedback/exportfeedbackreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Project sources","link":"/docs/platform/customization/reunite-api/openapi/project-sources","routeSlug":"/docs/platform/customization/reunite-api/openapi/project-sources","items":[{"label":"List all project sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/project-sources/listprojectsources","routeSlug":"/docs/platform/customization/reunite-api/openapi/project-sources/listprojectsources","metadata":{"seo":{"title":"List all project sources","description":"Lists the source of the project.A project has exactly one source, so the list always holds one item.The pagination parameters are accepted for consistency with other list operations.A source in an external Git repository includes the credentialId of the credential that Redocly uses to access the repository.Use it to rotate the access token of the credential."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProjectSources","name":"List all project sources","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"List all project sources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists the source of the project."," ","A project has exactly one source, so the list always holds one item."," ","The pagination parameters are accepted for consistency with other list operations."," ","A source in an external Git repository includes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credentialId"]}," of the credential that Redocly uses to access the repository."," ","Use it to rotate the access token of the credential."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org.project.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the next page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"a25fgaksjf23la=="},{"name":"before","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the previous page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"bfg23aksjf23zb1=="},{"name":"limit","in":"query","schemaId":"schema_11","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use to return a number of results per page."," ","If there is more data, use in combination with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," to page through the data."]}]},"example":10}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/sources","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"}],"query":[{"name":"after","in":"query","required":false,"example":"a25fgaksjf23la==","schemaId":"schema_1"},{"name":"before","in":"query","required":false,"example":"bfg23aksjf23zb1==","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_11"}],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/sources","href":"project-sources/listprojectsources","openApiOperationId":"listProjectSources","summary":"List all project sources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectSourceList"}},"schemaId":"components/schemas/ProjectSourceList"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectSourceList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectSourceList"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-sources/listprojectsources"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/sources"},{"label":"Retrieve a project source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/project-sources/getprojectsourcebyid","routeSlug":"/docs/platform/customization/reunite-api/openapi/project-sources/getprojectsourcebyid","metadata":{"seo":{"title":"Retrieve a project source","description":"Retrieves the source of the project.A source in an external Git repository includes the credentialId of the credential that Redocly uses to access the repository."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectSourceById","name":"Retrieve a project source","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources~1{sourceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Retrieve a project source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves the source of the project."," ","A source in an external Git repository includes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credentialId"]}," of the credential that Redocly uses to access the repository."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org.project.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"},{"name":"sourceId","in":"path","schemaId":"schema_17","description":"Project source ID.","required":true,"example":"rem_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources~1{sourceId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources~1{sourceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/sources/{sourceId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"},{"name":"sourceId","in":"path","required":true,"example":"rem_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/sources/{sourceId}","href":"project-sources/getprojectsourcebyid","openApiOperationId":"getProjectSourceById","summary":"Retrieve a project source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectSource"}},"schemaId":"components/schemas/ProjectSource"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1sources~1{sourceId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectSource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectSource"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-sources/getprojectsourcebyid"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/sources/{sourceId}"}],"content":{"contentType":"group","meta":{"name":"Project sources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project sources","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to project sources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/sources","summary":"List all project sources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-sources/listprojectsources","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/sources/{sourceId}","summary":"Retrieve a project source","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-sources/getprojectsourcebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Pushes","link":"/docs/platform/customization/reunite-api/openapi/pushes","routeSlug":"/docs/platform/customization/reunite-api/openapi/pushes","items":[{"label":"Push files to remote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/pushes/push","routeSlug":"/docs/platform/customization/reunite-api/openapi/pushes/push","metadata":{"seo":{"title":"Push files to remote","description":"Push discovered files as a remote content.Files should be sent as a multipart/form-data.Commit details like commit message and author can be sent as a JSON object in the commit field.The complete multipart body must not exceed 500 MiB, including files, fields, and multipart overhead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"push","name":"Push files to remote","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Push files to remote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Push discovered files as a remote content."," ","Files should be sent as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multipart/form-data"]},"."," ","Commit details like commit message and author can be sent as a JSON object in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commit"]}," field."," ","The complete multipart body must not exceed 500 MiB, including files, fields, and multipart overhead."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.remotes.update"]}," permission."," ","The CLI ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," command creates or updates the remote before it pushes files, so it also requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.remotes.create"]},"."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/Push"}},"schemaId":"components/schemas/Push","pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orgs/{orgId}/projects/{projectId}/pushes","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/Push"}},"responseCodes":["201","400","401","403","404","413","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/pushes","href":"pushes/push","openApiOperationId":"push","summary":"Push files to remote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"schemaId":"components/schemas/Push","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/Push"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Content pushed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Push"}},"schemaId":"components/schemas/Push"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"413","description":"Push body exceeds 500 MiB.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Push","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Push"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"413","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pushes/push"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/pushes"},{"label":"List all pushes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/pushes/listpushes","routeSlug":"/docs/platform/customization/reunite-api/openapi/pushes/listpushes","metadata":{"seo":{"title":"List all pushes","description":"List all pushes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPushes","name":"List all pushes","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"List all pushes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all pushes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.remotes.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the next page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"a25fgaksjf23la=="},{"name":"before","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the previous page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"bfg23aksjf23zb1=="},{"name":"sort","in":"query","schemaId":"schema_12","description":"Push list can be sorted by `id` only.\n\nTo sort in descending order, use `-id`.\nTo sort in ascending order, use `id`.\n\nBy default, push list is sorted by `id` in descending order, which corresponds to the newest pushes first.","example":"-id"},{"name":"filter","in":"query","schemaId":"schema_1","description":"Filter pushes by:\n  - `id`\n  - `isMainBranch`\n  - `replace`\n  - `scoutJobId`\n\nThis field requires a special format.\n\nFor more information, see [Filter results](#section/filter-results).","example":"status:approved createdAt:30d"},{"name":"limit","in":"query","schemaId":"schema_11","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use to return a number of results per page."," ","If there is more data, use in combination with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," to page through the data."]}]},"example":10},{"name":"search","in":"query","schemaId":"schema_1","description":"Search pushes by query string.\n\nPushes are searched by:\n  - `id`\n  - `scoutJobId`\n  - `isMainBranch` and `replace`, only when the search term is exactly `true` or `false`","example":"text-to-search"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/pushes","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"}],"query":[{"name":"after","in":"query","required":false,"example":"a25fgaksjf23la==","schemaId":"schema_1"},{"name":"before","in":"query","required":false,"example":"bfg23aksjf23zb1==","schemaId":"schema_1"},{"name":"sort","in":"query","required":false,"example":"-id","schemaId":"schema_12"},{"name":"filter","in":"query","required":false,"example":"status:approved createdAt:30d","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_11"},{"name":"search","in":"query","required":false,"example":"text-to-search","schemaId":"schema_1"}],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/pushes","href":"pushes/listpushes","openApiOperationId":"listPushes","summary":"List all pushes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PushList"}},"schemaId":"components/schemas/PushList"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PushList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PushList"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pushes/listpushes"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/pushes"},{"label":"Retrieve a push","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/pushes/getpush","routeSlug":"/docs/platform/customization/reunite-api/openapi/pushes/getpush","metadata":{"seo":{"title":"Retrieve a push","description":"Retrieve a push."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPush","name":"Retrieve a push","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes~1{pushId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Retrieve a push","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve a push."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.remotes.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"},{"name":"pushId","in":"path","schemaId":"schema_18","description":"Push ID.","required":true,"example":"push_01hhh91dhc2kg9naf476y7qmas"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes~1{pushId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes~1{pushId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/pushes/{pushId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"},{"name":"pushId","in":"path","required":true,"example":"push_01hhh91dhc2kg9naf476y7qmas","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/pushes/{pushId}","href":"pushes/getpush","openApiOperationId":"getPush","summary":"Retrieve a push"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Push"}},"schemaId":"components/schemas/Push"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1pushes~1{pushId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Push","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Push"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pushes/getpush"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/pushes/{pushId}"}],"content":{"contentType":"group","meta":{"name":"Pushes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pushes","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to pushes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/pushes","summary":"Push files to remote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pushes/push","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/pushes","summary":"List all pushes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pushes/listpushes","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/pushes/{pushId}","summary":"Retrieve a push","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pushes/getpush","deprecated":false}]}]}]}]}},{"type":"group","label":"Remotes","link":"/docs/platform/customization/reunite-api/openapi/remotes","routeSlug":"/docs/platform/customization/reunite-api/openapi/remotes","items":[{"label":"List all remotes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/remotes/listremotes","routeSlug":"/docs/platform/customization/reunite-api/openapi/remotes/listremotes","metadata":{"seo":{"title":"List all remotes","description":"List all remotes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRemotes","name":"List all remotes","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"List all remotes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"plans":["Scale","Enterprise"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists the remote content of the project."," ","A Git remote includes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credentialId"]}," of the credential that Redocly uses to access its repository."," ","Use it to rotate the access token of the credential."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.remotes.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the next page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.nextPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"a25fgaksjf23la=="},{"name":"before","in":"query","schemaId":"schema_1","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor of the previous page."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," contains it as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]}," query parameter, so you can also request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.previousPage"]}," directly."," ","The cursor is opaque, and its internal structure is subject to change."]}]},"example":"bfg23aksjf23zb1=="},{"name":"sort","in":"query","schemaId":"schema_12","description":"Remote list can be sorted by `id` and `createdAt`.\n\nTo sort in descending order, prefix the field with `-`, for example `-createdAt`.\nTo sort in ascending order, use the field name, for example `createdAt`.\n\nBy default, remote list is sorted by `id` in descending order, which corresponds to the newest remotes first.","example":"-id"},{"name":"filter","in":"query","schemaId":"schema_1","description":"Filter remotes by:\n  - `id`\n  - `mountBranchName`\n  - `type`, one of `GIT`, `URL`, or `CICD`\n\nThis field requires a special format.\n\nFor more information, see [Filter results](#section/filter-results).","example":"status:approved createdAt:30d"},{"name":"limit","in":"query","schemaId":"schema_11","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use to return a number of results per page."," ","If there is more data, use in combination with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," to page through the data."]}]},"example":10},{"name":"search","in":"query","schemaId":"schema_1","description":"Search remotes by query string.\n\nRemotes are searched by:\n  - `id`\n  - `mountPath`\n  - `mountBranchName`","example":"text-to-search"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/remotes","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"}],"query":[{"name":"after","in":"query","required":false,"example":"a25fgaksjf23la==","schemaId":"schema_1"},{"name":"before","in":"query","required":false,"example":"bfg23aksjf23zb1==","schemaId":"schema_1"},{"name":"sort","in":"query","required":false,"example":"-id","schemaId":"schema_12"},{"name":"filter","in":"query","required":false,"example":"status:approved createdAt:30d","schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_11"},{"name":"search","in":"query","required":false,"example":"text-to-search","schemaId":"schema_1"}],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/remotes","href":"remotes/listremotes","openApiOperationId":"listRemotes","summary":"List all remotes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteList"}},"schemaId":"components/schemas/RemoteList"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","description":"Payment Required.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RemoteList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoteList"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remotes/listremotes"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/remotes"},{"label":"Retrieve a remote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/platform/customization/reunite-api/openapi/remotes/getremote","routeSlug":"/docs/platform/customization/reunite-api/openapi/remotes/getremote","metadata":{"seo":{"title":"Retrieve a remote","description":"Retrieve a remote"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRemote","name":"Retrieve a remote","isWebhook":false,"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":3,"label":"Retrieve a remote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"plans":["Scale","Enterprise"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves a remote of the project."," ","A Git remote includes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credentialId"]}," of the credential that Redocly uses to access its repository."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["project.remotes.read"]}," permission."]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"Organization ID.","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7"},{"name":"projectId","in":"path","schemaId":"schema_10","description":"Project ID.","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm"},{"name":"remoteId","in":"path","schemaId":"schema_17","description":"Remote ID.","required":true,"example":"rem_01h1s5z6vf2mm1mz3hevnn9va7"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-redocly-client","in":"header","schemaId":"schema_4","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the calling client as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<name>/<version>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reunite-ui/0.92.1"]},"."," ","Used for API consumer observability."," ","Requests without it are attributed as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},"."]}]},"example":"reunite-ui/0.92.1"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}","servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"example":"org_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_0"},{"name":"projectId","in":"path","required":true,"example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","schemaId":"schema_10"},{"name":"remoteId","in":"path","required":true,"example":"rem_01h1s5z6vf2mm1mz3hevnn9va7","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[{"name":"x-redocly-client","in":"header","required":false,"example":"reunite-ui/0.92.1","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","429","500"],"pointer":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}","href":"remotes/getremote","openApiOperationId":"getRemote","summary":"Retrieve a remote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Remote"}},"schemaId":"components/schemas/Remote"},{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"User is not authorized to access this resource.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"402","description":"Payment Required.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Resource not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Too Many Requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The organization exceeded the rate limit for this operation."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header gives the number of seconds to wait before the next request."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"Retry-After":{"description":"Number of seconds to wait before sending another request.","schema":{"type":"integer","minimum":1},"example":30}},"headerSchemaId":"schema_5"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orgs~1{orgId}~1projects~1{projectId}~1remotes~1{remoteId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Remote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Remote"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"402","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remotes/getremote"}],"panels":[]}]},"httpPath":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}"}],"content":{"contentType":"group","meta":{"name":"Remotes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remotes","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to remotes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orgs/{orgId}/projects/{projectId}/remotes","summary":"List all remotes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/remotes/listremotes","deprecated":false},{"title":"/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}","summary":"Retrieve a remote","prefix":{"name":"get","color":"get"},"badges":[],"link":"/remotes/getremote","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","title":"Problem","properties":{"type":{"type":"string","format":"uri-reference","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["URI reference that uniquely identifies the problem type only in the context of the provided API."," ","Opposed to the specification in RFC 9457 (formerly RFC 7807), it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type."]}]},"default":"about:blank","example":"/some/uri-reference"},"title":{"type":"string","description":"Short summary of the problem type.\nWritten in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n","example":"some title for the error situation"},"status":{"type":"integer","format":"int32","description":"HTTP status code generated by the origin server for this occurrence of the problem.\n","minimum":100,"exclusiveMaximum":600,"example":400},"detail":{"type":"string","description":"Human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed.\nWritten in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n","example":"some description for the error situation"},"instance":{"type":"string","format":"uri-reference","description":"URI reference that identifies the specific occurrence of the problem. For example, by adding a fragment identifier or sub-path to the problem type.\nMay be used to locate the root of this problem in the source code.\n","example":"/some/uri-reference#specific-occurrence-context"},"object":{"type":"string","enum":["problem"]},"requestId":{"type":"string","description":"Unique identifier of the request that produced this problem.\nShare it with support when reporting the error.\n","example":"req-abc-123"},"code":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Machine-readable identifier of the problem, stable across wording changes of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]},"."," ","Present only for problems a client is expected to branch on; such a problem explains the occurrence in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]},"."]}]},"example":"usageLimitExceeded"},"reason":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Machine-readable refinement of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," that names which rule produced the problem."]}]},"example":"MAX_ACTIVE_RUNS_PER_ORGANIZATION_REACHED"},"errors":{"type":"array","description":"Additional information about the error situation.\nMay be omitted if no additional information is available.\n"}},"required":["type","title","status","object"]}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","properties":{"nextPage":{"type":["string","null"],"format":"uri-reference","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Path of the next page, relative to the API server URL."," ","Append the value to the server URL to get the next page."," ","The path keeps the query parameters of the request and sets ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]}," to the cursor of the next page."," ","When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", there is no next page."]}]},"example":"/orgs/org_123/projects?limit=10&after=a25fgaksjf23la=="},"previousPage":{"type":["string","null"],"format":"uri-reference","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Path of the previous page, relative to the API server URL."," ","Append the value to the server URL to get the previous page."," ","The path keeps the query parameters of the request and sets ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]}," to the cursor of the previous page."," ","When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", there is no previous page."]}]},"example":"/orgs/org_123/projects?limit=10&before=bfg23aksjf23zb1=="},"limit":{"type":"integer","minimum":1,"maximum":100,"default":10,"description":"Value showing how many items are in the page limit."}},"required":["nextPage","previousPage","limit"]}},"components/schemas/AuditLogExportJobCreated":{"id":"components/schemas/AuditLogExportJobCreated","kind":"json-schema","title":"AuditLogExportJobCreated","data":{"type":"object","description":"Details of the created audit log export job.","properties":{"id":{"readOnly":true,"type":"string","pattern":"^exp_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier for the export job, prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exp_"]},"."]}]},"example":"exp_01hh1t9sa6gwfv5naz04gr7ehm"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Export job creation time (ISO 8601)."]}]}}},"required":["id","createdAt"]}},"components/schemas/AuditLogExportStatus":{"id":"components/schemas/AuditLogExportStatus","kind":"json-schema","title":"AuditLogExportStatus","data":{"type":"string","description":"Current status of the export job.","enum":["IN_PROGRESS","COMPLETED","FAILED"]}},"components/schemas/AuditLogExportJob":{"id":"components/schemas/AuditLogExportJob","kind":"json-schema","title":"AuditLogExportJob","data":{"type":"object","description":"Audit log export job status and metadata.","properties":{"id":{"readOnly":true,"type":"string","pattern":"^exp_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier for the export job, prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exp_"]},"."]}]},"example":"exp_01hh1t9sa6gwfv5naz04gr7ehm"},"status":{"$ref":"#/components/schemas/AuditLogExportStatus"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Export job creation time (ISO 8601)."]}]}}},"required":["id","status","createdAt"]}},"components/schemas/AuditLogEventType":{"id":"components/schemas/AuditLogEventType","kind":"json-schema","title":"AuditLogEventType","data":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["CloudEvent ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," value emitted for an audit-loggable action."," ","Only events whose ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is in this list are returned by the audit log export endpoints."]}]},"enum":["com.redocly.apiKey.created","com.redocly.apiKey.updated","com.redocly.apiKey.revoked","com.redocly.gitIdentity.linked","com.redocly.gitIdentity.unlinked","com.redocly.gitIdentity.removed","com.redocly.scimCredential.created","com.redocly.scimCredential.revoked","com.redocly.invite.created","com.redocly.invite.resent","com.redocly.userInvite.accepted","com.redocly.membership.created","com.redocly.membership.updated","com.redocly.membership.removed","com.redocly.team.created","com.redocly.team.deleted","com.redocly.teamMember.added","com.redocly.teamMember.removed","com.redocly.syncedTeamMember.added","com.redocly.syncedTeamMember.removed","com.redocly.teamManager.added","com.redocly.teamManager.removed","com.redocly.organization.created","com.redocly.organization.updated","com.redocly.organization.slugUpdated","com.redocly.organization.removed","com.redocly.project.created","com.redocly.project.updated","com.redocly.project.slugUpdated","com.redocly.project.urlUpdated","com.redocly.project.removed","com.redocly.projectConfig.updated","com.redocly.projectCustomDomain.verified","com.redocly.projectCustomDomain.removed","com.redocly.branch.created","com.redocly.branch.updated","com.redocly.branch.removed","com.redocly.gitAccess.pushed","com.redocly.remote.created","com.redocly.remote.deleted","com.redocly.gitCredential.rotated","com.redocly.notificationSettings.updated","com.redocly.notifications.disabled","com.redocly.subscription.updated","com.redocly.subscription.churned","com.redocly.subscription.reactivated","com.redocly.subscription.trialEnded","com.redocly.pullRequest.created","com.redocly.pullRequest.closed","com.redocly.pullRequest.reopened","com.redocly.pullRequest.merged","com.redocly.pullRequest.approved","com.redocly.pullRequest.requestedChanges","com.redocly.pullRequest.reviewRequested","com.redocly.pullRequest.readyForReview","com.redocly.pullRequest.markedAsDraft","com.redocly.pullRequest.commented","com.redocly.pullRequest.commitPushed","com.redocly.pullRequest.forcePushed","com.redocly.pullRequest.visualReviewUpdated"],"example":"com.redocly.pullRequest.created"}},"components/schemas/id":{"id":"components/schemas/id","kind":"json-schema","title":"id","data":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Project ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prj_"]},"."]}]},"type":"string","pattern":"^prj_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true}},"components/schemas/slug":{"id":"components/schemas/slug","kind":"json-schema","title":"slug","data":{"description":"Project slug.","type":"string","example":"project_red-owl-352"}},"components/schemas/AuditLogExportEvent":{"id":"components/schemas/AuditLogExportEvent","kind":"json-schema","title":"AuditLogExportEvent","data":{"type":"object","description":"One audit log export record.","required":["id","type"],"properties":{"id":{"type":"string","description":"Unique event identifier.","example":"evt_2fxb8r4kq7m3ndp9z6ja501"},"object":{"type":"string","description":"Entity name.","enum":["event"],"readOnly":true},"type":{"$ref":"#/components/schemas/AuditLogEventType"},"time":{"type":"string","format":"date-time","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Event timestamp (ISO 8601)."]}]},"example":"2026-04-15T14:43:08.172Z"},"subject":{"type":"string","description":"Subject URI or resource ID the event refers to.","example":"pr_7wnk3jm9xp2d4rv8qh5a01"},"projectId":{"$ref":"#/components/schemas/id"},"projectSlug":{"$ref":"#/components/schemas/slug"},"clientIp":{"type":"string","description":"IP address of the client that triggered the event.","example":"198.51.100.42"},"actor":{"oneOf":[{"type":"null"},{"type":"object","description":"Actor that triggered the event.","properties":{"id":{"type":"string","pattern":"^(usr|gid|wh|cj)_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"usr_01h2r5f6qy8kr42p8yfw52spq6"},"object":{"type":"string","enum":["user","gitIdentity","webhook","cronJob"],"example":"user"},"uri":{"type":"string","format":"uri","example":"https://app.cloud.redocly.com/api/users/usr_01h2r5f6qy8kr42p8yfw52spq6"}},"required":["id","object","uri"],"additionalProperties":false}]}},"additionalProperties":false}},"components/schemas/CredentialType":{"id":"components/schemas/CredentialType","kind":"json-schema","title":"CredentialType","data":{"type":"string","format":"enum","description":"Credential type.","enum":["GITHUB_USER","GITLAB_USER","BITBUCKET_USER","AZURE_USER","URL","GITHUB_CLOUD_APP_INSTALLATION","GITHUB_SERVER_APP_INSTALLATION","GITHUB_SERVER_APP","GITLAB_SELF_MANAGED_APP","GITHUB_CLOUD_INTERNAL_APP_INSTALLATION","MCP_HEADERS","MCP_BEARER","MCP_API_KEY","SUPPORT_DESK"]}},"components/schemas/AuthType":{"id":"components/schemas/AuthType","kind":"json-schema","title":"AuthType","data":{"type":"string","format":"enum","description":"Credential auth type.","enum":["BASIC","PERSONAL_ACCESS_TOKEN","PERSONAL_ACCESS_TOKEN_FOR_ORGANIZATION","PROJECT_ACCESS_TOKEN","INSTALLATION_ACCESS_TOKEN","OAUTH2","BEARER","API_KEY"]}},"components/schemas/GitHubInstallationPublicCredential":{"id":"components/schemas/GitHubInstallationPublicCredential","kind":"json-schema","title":"GitHubInstallationPublicCredential","data":{"title":"GitHubInstallationPublicCredential","type":"object","properties":{"installationId":{"type":"number"},"namespaceId":{"type":"string"},"repositoryId":{"type":"string"}},"required":["namespaceId","repositoryId"]}},"components/schemas/GitHubEEServerAppPublicCredential":{"id":"components/schemas/GitHubEEServerAppPublicCredential","kind":"json-schema","title":"GitHubEEServerAppPublicCredential","data":{"title":"GitHubEEServerAppPublicCredential","type":"object","properties":{"appId":{"type":"string"},"clientId":{"type":"string"},"url":{"type":"string"},"apiUrl":{"type":"string"},"appName":{"type":"string"}},"required":["appId","clientId","url"]}},"components/schemas/GitLabSelfManagedAppPublicCredential":{"id":"components/schemas/GitLabSelfManagedAppPublicCredential","kind":"json-schema","title":"GitLabSelfManagedAppPublicCredential","data":{"title":"GitLabSelfManagedAppPublicCredential","type":"object","properties":{"appId":{"type":"string"},"url":{"type":"string"}},"required":["appId","url"]}},"components/schemas/AzureDevOpsUserPATPublicCredential":{"id":"components/schemas/AzureDevOpsUserPATPublicCredential","kind":"json-schema","title":"AzureDevOpsUserPATPublicCredential","data":{"title":"AzureDevOpsUserPATPublicCredential","type":"object","properties":{"organizationName":{"type":"string"}},"required":["organizationName"]}},"components/schemas/BitbucketCloudUserProjectTokenPublicCredential":{"id":"components/schemas/BitbucketCloudUserProjectTokenPublicCredential","kind":"json-schema","title":"BitbucketCloudUserProjectTokenPublicCredential","data":{"title":"BitbucketCloudUserProjectTokenPublicCredential","type":"object","properties":{"workspace":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}."]}]}}},"required":["workspace"]}},"components/schemas/McpPublicCredential":{"id":"components/schemas/McpPublicCredential","kind":"json-schema","title":"McpPublicCredential","data":{"title":"McpPublicCredential","type":"object","description":"Non-secret part of the credential of an agent MCP server: the header that carries the API key, and the names of the secret headers besides the authentication header. Values live in the secret store.","properties":{"header":{"description":"Request header that carries the API key; absent for a bearer token.","type":"string","example":"X-Api-Key"},"secretHeaderNames":{"description":"Names of the secret headers besides the authentication header.","type":"array","items":{"type":"string"},"example":["X-Tenant"]}},"required":["secretHeaderNames"]}},"components/schemas/CredentialSchemaBase":{"id":"components/schemas/CredentialSchemaBase","kind":"json-schema","title":"CredentialsSchemaBase","data":{"title":"CredentialsSchemaBase","type":"object","properties":{"id":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Credential ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cred_"]},"."]}]},"type":"string","pattern":"^cred_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"cred_01h1s5z6vf2mm1mz3hevnn9va7","readOnly":true},"object":{"description":"Entity name.","type":"string","enum":["credential"],"readOnly":true},"uri":{"description":"Canonical URI for the credential resource.","type":"string","format":"uri","readOnly":true,"example":"https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/credentials/cred_01h1s5z6vf2mm1mz3hevnn9va7"},"type":{"$ref":"#/components/schemas/CredentialType"},"authType":{"$ref":"#/components/schemas/AuthType"},"name":{"type":"string"},"description":{"type":"string"},"publicData":{"type":"object","description":"Credential public data.","oneOf":[{"$ref":"#/components/schemas/GitHubInstallationPublicCredential"},{"$ref":"#/components/schemas/GitHubEEServerAppPublicCredential"},{"$ref":"#/components/schemas/GitLabSelfManagedAppPublicCredential"},{"$ref":"#/components/schemas/AzureDevOpsUserPATPublicCredential"},{"$ref":"#/components/schemas/BitbucketCloudUserProjectTokenPublicCredential"},{"$ref":"#/components/schemas/McpPublicCredential"}]},"oAuth2Data":{"type":"object","description":"Credential OAuth2 data.","readOnly":true,"properties":{"id":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"OAuth2 ID. Unique identifier of OAuth2 account.","example":"4acc1f09-1751-6f79-b156-b6877ee205a2"},"userName":{"type":"string","description":"OAuth2 user name.","example":"john-doe"},"displayName":{"type":"string","description":"OAuth2 display name.","example":"John Doe"},"email":{"type":"string","description":"OAuth2 email.","example":"john-doe@mail.com"},"avatarUrl":{"type":"string","description":"OAuth2 avatar URL.","example":"https://avatars.githubusercontent.com/u/1?v=4"}},"required":["id","userName","displayName"]},"userId":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["User ID this credentials belongs to. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usr_"]},"."]}]},"type":"string","pattern":"^usr_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"usr_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"isShared":{"type":"boolean","default":false},"isBroken":{"type":"boolean","default":false,"readOnly":true},"parentId":{"type":"string","pattern":"^cred_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Credential parent ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cred_"]},"."]}]},"example":"cred_01h4e71x94vd68a1farnbfapzg"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["id","object","uri","type","createdAt","updatedAt"]}},"components/schemas/AccessTokenCredential":{"id":"components/schemas/AccessTokenCredential","kind":"json-schema","title":"AccessTokenCredential","data":{"title":"AccessTokenCredential","type":"object","writeOnly":true,"properties":{"accessToken":{"type":"string"}},"required":["accessToken"]}},"components/schemas/OAuth2CodeCredential":{"id":"components/schemas/OAuth2CodeCredential","kind":"json-schema","title":"OAuth2CodeCredential","data":{"title":"OAuth2CodeCredential","type":"object","writeOnly":true,"properties":{"code":{"description":"OAuth code to be used to get access/refresh tokens.","type":"string","example":"Yzk5ZDczMzRlNDEwY"}},"required":["code"]}},"components/schemas/GithubAppCodeCredential":{"id":"components/schemas/GithubAppCodeCredential","kind":"json-schema","title":"GithubAppCodeCredential","data":{"title":"GithubAppCodeCredential","type":"object","writeOnly":true,"properties":{"code":{"description":"GithubApp code to be used to get exchange code on App secrets.","type":"string","example":"Yzk5ZDczMzRlNDEwY"},"url":{"description":"GithubApp url to be used to get exchange code on App secrets.","type":"string","example":"https://github.app.com"}},"required":["code","url"]}},"components/schemas/GitLabSelfManagedAppSecretCredential":{"id":"components/schemas/GitLabSelfManagedAppSecretCredential","kind":"json-schema","title":"GitLabSelfManagedAppSecretCredential","data":{"title":"GitLabSelfManagedAppSecretCredential","type":"object","writeOnly":true,"properties":{"appSecret":{"type":"string"},"webhookSecret":{"type":"string"}},"required":["appSecret"]}},"components/schemas/GitHubEEServerAppSecretCredential":{"id":"components/schemas/GitHubEEServerAppSecretCredential","kind":"json-schema","title":"GitHubEEServerAppSecretCredential","data":{"title":"GitHubEEServerAppSecretCredential","type":"object","writeOnly":true,"properties":{"clientSecret":{"type":"string"},"privateKey":{"type":"string"},"webhookSecret":{"type":"string"}}}},"components/schemas/CredentialSchema":{"id":"components/schemas/CredentialSchema","kind":"json-schema","title":"Credential","data":{"title":"Credential","type":"object","allOf":[{"$ref":"#/components/schemas/CredentialSchemaBase"},{"type":"object","properties":{"secretData":{"type":"object","description":"Credential secret data.","writeOnly":true,"oneOf":[{"$ref":"#/components/schemas/AccessTokenCredential"},{"$ref":"#/components/schemas/OAuth2CodeCredential"},{"$ref":"#/components/schemas/GithubAppCodeCredential"},{"$ref":"#/components/schemas/GitLabSelfManagedAppSecretCredential"},{"$ref":"#/components/schemas/GitHubEEServerAppSecretCredential"}]}}}]}},"components/schemas/CredentialPatchResponse":{"id":"components/schemas/CredentialPatchResponse","kind":"json-schema","title":"CredentialPatchResponse","data":{"title":"CredentialPatchResponse","type":"object","allOf":[{"$ref":"#/components/schemas/CredentialSchema"},{"type":"object","properties":{"warnings":{"type":"array","description":"Problems that do not block the update.\nFor example, Redocly cannot set up a webhook for a repository that uses this credential.\n","readOnly":true,"items":{"type":"string","example":"Failed to set up webhook for repository \"fe5d7747-af71-449a-951b-f781f54603af\": Azure DevOps token does not have sufficient permissions. Please check token scopes."}}},"required":["warnings"]}]}},"components/schemas/CreateCredentialRotationRequest":{"id":"components/schemas/CreateCredentialRotationRequest","kind":"json-schema","title":"CreateCredentialRotationRequest","data":{"title":"CreateCredentialRotationRequest","type":"object","properties":{"credentialId":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ID of the credential whose access token is replaced. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cred_"]},"."]}]},"type":"string","pattern":"^cred_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"cred_01h1s5z6vf2mm1mz3hevnn9va7"},"secretData":{"description":"New access token for the credential.","$ref":"#/components/schemas/AccessTokenCredential"}},"required":["credentialId","secretData"]}},"components/schemas/Feedback":{"id":"components/schemas/Feedback","kind":"json-schema","title":"Feedback","data":{"type":"object","title":"Feedback","additionalProperties":false,"properties":{"id":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Feedback ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fb_"]},"."]}]},"type":"string","pattern":"^fb_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"fb_01h1s5z6vf2mm1mz3hevnn9va7","readOnly":true},"object":{"description":"Entity name.","type":"string","enum":["feedback"],"readOnly":true},"uri":{"description":"Canonical URI for the feedback resource.","type":"string","format":"uri","readOnly":true,"example":"https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/feedback/fb_01h1s5z6vf2mm1mz3hevnn9va7"},"email":{"type":["string","null"],"format":"email","maxLength":254,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Email address of user who submitted the feedback or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"."]}]}},"path":{"type":"string","minLength":1,"maxLength":1000,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Absolute URL of the page where feedback is submitted (for example from the browser location). A value that is not a valid URL is accepted, but the feedback is marked as spam."]}]},"example":"https://example.com/docs/guide"},"location":{"type":["string","null"],"maxLength":5000,"description":"Identifies the location of the component.\nThis could be a code sample."},"lang":{"type":"string","maxLength":20,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the language of the component's location."," ","This could be the language of a code sample, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["js"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["php"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txt"]},"."]}]}},"feedbackComponent":{"type":"string","description":"Name that identifies UI component.","enum":["SENTIMENT","RATING","COMMENT","MOOD","PROBLEM","SCALE"]},"score":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Numeric value that maps to the feedback component, such as thumbs down (-1) or thumbs up (1), or a 1-5 star rating scale."]}]},"type":["integer","null"],"minimum":-1,"maximum":10},"maxScore":{"description":"Maximum score for the feedback component.","type":["integer","null"],"minimum":0,"maximum":10},"reasons":{"type":"array","description":"List of preset reasons for feedback.","items":{"type":"string","maxLength":5000,"description":"Reason for feedback."}},"comment":{"type":"string","maxLength":5000,"description":"Free-form text feedback."},"agent":{"type":["string","null"],"maxLength":200,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Name of the AI agent that submitted the feedback, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," for user-submitted feedback."]}]},"example":"Cursor"},"targetFeature":{"type":["string","null"],"maxLength":500,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Documentation feature the feedback refers to (for agent submissions), or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," for user-submitted feedback."]}]},"example":"Respect Monitoring API"},"origin":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Origin of the feedback. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FORM"]}," is the feedback form on the page, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API"]}," is a direct API call (for example an agent that follows ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["llms.txt"]}," instructions), and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MCP"]}," is the MCP server ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["submit-feedback"]}," tool. When omitted on create, defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API"]}," if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["agent"]}," is set and to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FORM"]}," otherwise."]}]},"enum":["FORM","API","MCP"],"example":"MCP"},"metadata":{"type":"object","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extra tracking fields. The server sets ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userAgent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ipAddress"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["platform"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," (read-only). ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_time"]}," pass through if present but are not verified; do not use for access or identity. Any other key is stored with its value redacted to a placeholder."]}]},"properties":{"userAgent":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["User agent string of the browser that submitted the feedback. Populated by the server from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["User-Agent"]}," header."]}]},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","readOnly":true},"ipAddress":{"type":"string","description":"IP address of the user who submitted the feedback. Populated by the server.","example":"127.0.0.1","readOnly":true},"platform":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Platform from which the feedback originates. Populated by the server from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sec-Ch-Ua-Platform"]}," header."]}]},"example":"Windows NT 10.0; Win64; x64","readOnly":true},"email":{"type":"string","format":"email","description":"Email address from the user's authentication context. Populated by the server from OIDC claims.","example":"john.doe@acme.com","readOnly":true},"id":{"type":"string","description":"Unverified; whatever the client sent. Not a trusted user ID."},"firstName":{"type":"string","description":"Unverified; client-supplied if present."},"lastName":{"type":"string","description":"Unverified; client-supplied if present."},"auth_time":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Unverified; client-supplied. Not a server-asserted session or token time."}},"additionalProperties":true},"createdAt":{"type":"string","format":"date-time","readOnly":true},"status":{"type":"string","description":"Feedback status.","enum":["NEW","IN_REVIEW","RESOLVED","ARCHIVED","SPAM"],"example":"ARCHIVED","readOnly":true},"organizationId":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organization ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org_"]},"."]}]},"type":"string","pattern":"^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"org_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"projectId":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Project ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prj_"]},"."]}]},"type":"string","pattern":"^prj_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"prj_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"internalComment":{"type":["string","null"],"description":"Internal comment for the feedback.","example":"This feedback is related to the issue 235.","readOnly":true},"internalCommentUpdatedAt":{"type":"string","format":"date-time","description":"Date and time when the internal comment is updated.","readOnly":true},"internalCommentUpdatedById":{"type":"string","description":"ID of the user who updated the internal comment.","readOnly":true}},"required":["id","uri","path","feedbackComponent","createdAt","object","organizationId","projectId","status","origin"]}},"components/schemas/FeedbackList":{"id":"components/schemas/FeedbackList","kind":"json-schema","title":"FeedbackList","data":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"page":{"$ref":"#/components/schemas/Page"},"data":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Feedback"}}},"required":["object","page","data"]}},"components/schemas/PatchFeedbackRequest":{"id":"components/schemas/PatchFeedbackRequest","kind":"json-schema","title":"Feedback PATCH request","data":{"type":"object","title":"Feedback PATCH request","minProperties":1,"properties":{"status":{"type":"string","description":"Feedback status.","enum":["NEW","IN_REVIEW","RESOLVED","ARCHIVED","SPAM"],"example":"ARCHIVED","writeOnly":true},"internalComment":{"type":["string","null"],"description":"Internal comment for the feedback.","example":"This feedback is related to the issue 235.","writeOnly":true}}}},"components/schemas/GitProviderType":{"id":"components/schemas/GitProviderType","kind":"json-schema","title":"GitProviderType","data":{"type":"string","format":"enum","description":"Git provider type.","enum":["GITHUB_CLOUD","GITHUB_SERVER","GITLAB_CLOUD","GITLAB_SELF_MANAGED","BITBUCKET_CLOUD","BITBUCKET_DATACENTER","AZURE_DEVOPS_SERVICES","AZURE_DEVOPS_SERVER"]}},"components/schemas/GitProvider":{"id":"components/schemas/GitProvider","kind":"json-schema","title":"GitProvider","data":{"type":"object","description":"Git provider configuration.","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/GitProviderType"},"name":{"type":"string","example":"Redocly GitLab"},"publicConfig":{"type":"object","properties":{"url":{"type":"string","example":"https://gitlab.redocly.dev"},"clientId":{"type":"string","example":"05489443ec38b38f2327cdde9d5f51f284ae1d726130b300ecda0a259010c759"},"appName":{"type":"string","example":"redocly"}}},"isCustom":{"type":"boolean","description":"Indicates whether this provider is a custom provider added to the organization."}},"required":["id","type","name","isCustom"]}},"components/schemas/ProjectSource":{"id":"components/schemas/ProjectSource","kind":"json-schema","title":"ProjectSource","data":{"type":"object","properties":{"id":{"type":"string","pattern":"^rem_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"rem_01hc2rvwxf7jyj1er504khx8e7","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Project source ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rem_"]},"."]}]},"readOnly":true},"uri":{"description":"Canonical URI for the project source resource.","type":"string","format":"uri","readOnly":true,"example":"https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/sources/rem_01hc2rvwxf7jyj1er504khx8e7"},"branchName":{"description":"Main branch of the project.","type":"string","example":"main"},"contentPath":{"description":"Path to the project content in the repository.","type":"string","example":"/"},"repoName":{"description":"Name of the repository. Present when Redocly can access the repository.","type":"string","example":"Repo Name"},"repoUrl":{"description":"URL of the repository. Present when Redocly can access the repository.","type":"string","example":"https://github.com/example/example"},"isInternal":{"description":"Whether the project content is stored in the Redocly-hosted repository instead of an external Git repository. Internal sources have no Git provider fields and no credential.","type":"boolean","example":true},"isMonorepo":{"description":"Whether the project content is in a folder of the repository rather than at its root.","type":"boolean","example":true},"providerType":{"$ref":"#/components/schemas/GitProviderType"},"providerConfig":{"$ref":"#/components/schemas/GitProvider","description":"Git provider of the repository."},"canAccessRepo":{"type":"boolean","example":true,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether Redocly can access the repository with the source credential. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," usually means that the access token is expired or revoked."]}]}},"credentialId":{"type":"string","pattern":"^cred_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"cred_01hc2rvwxf7jyj1er504khx8e7","description":"ID of the credential Redocly uses to access the repository.\nUse it to rotate the access token of the credential.\nAbsent for internal sources."},"sourceId":{"type":"string","example":"rem_01hc2rvwxf7jyj1er504khx8e7","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," instead."]}]},"deprecated":true},"namespaceId":{"type":["string","null"],"description":"Git provider namespace of the repository, such as a GitHub organization or an Azure DevOps project.","example":"azure-test-org"},"repositoryId":{"type":"string","description":"Git provider identifier of the repository.","example":"redocly-testing"},"branchDeployStrategy":{"type":"string","description":"Which branches other than the main branch start builds.","enum":["NONE","SELECTED","ALL"]},"selectedDeployBranches":{"type":"array","description":"Branches that start a build when they're updated or a pull request targets them.","items":{"type":"string"}},"prDeploysEnabled":{"type":"boolean","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether pull requests start builds when they target the main branch or, with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SELECTED"]}," strategy, a branch in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["selectedDeployBranches"]},"."," ","Has no effect with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," strategy, which builds every branch."]}]}},"forksPrDeploysEnabled":{"type":"boolean","description":"Whether build starts for PRs from forks."},"visualReviewCheckDisabled":{"type":"boolean","default":false,"description":"Whether the Visual review check is disabled. A disabled check is reported as skipped instead of pending."},"createdAt":{"description":"Time when Redocly created the project source.","type":"string","format":"date-time","readOnly":true},"updatedAt":{"description":"Time of the last change to the project source.","type":"string","format":"date-time","readOnly":true},"object":{"description":"Entity name.","type":"string","enum":["projectSource"],"readOnly":true}},"required":["id","uri","branchName","contentPath","isInternal","isMonorepo","branchDeployStrategy","selectedDeployBranches","prDeploysEnabled","forksPrDeploysEnabled","visualReviewCheckDisabled","createdAt","updatedAt","object"]}},"components/schemas/ProjectSourceList":{"id":"components/schemas/ProjectSourceList","kind":"json-schema","title":"ProjectSourceList","data":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"page":{"$ref":"#/components/schemas/Page"},"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/ProjectSource"}}},"required":["object","page","data"]}},"components/schemas/MountPath":{"id":"components/schemas/MountPath","kind":"json-schema","title":"MountPath","data":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Path to the folder in the local repository where remote content is mounted. Paths outside of the project's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contentPath"]}," are not allowed."]}]},"example":"apis/test/@v1"}},"components/schemas/AutoSync":{"id":"components/schemas/AutoSync","kind":"json-schema","title":"AutoSync","data":{"type":"boolean","default":true,"description":"Whether Redocly syncs changes from the remote automatically."}},"components/schemas/AutoSyncDisabledAt":{"id":"components/schemas/AutoSyncDisabledAt","kind":"json-schema","title":"AutoSyncDisabledAt","data":{"type":["string","null"],"format":"date-time","readOnly":true,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Time when Redocly turned off auto-sync after repeated failed updates."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," when auto-sync is on or a user turned it off."]}]},"example":"2021-08-25T10:00:00.000Z"}},"components/schemas/AutoMerge":{"id":"components/schemas/AutoMerge","kind":"json-schema","title":"AutoMerge","data":{"type":"boolean","default":false,"description":"Auto merge changes from remote."}},"components/schemas/MountBranchName":{"id":"components/schemas/MountBranchName","kind":"json-schema","title":"MountBranchName","data":{"type":"string","description":"Name of the branch to mount.","example":"main"}},"components/schemas/GenericRemoteError":{"id":"components/schemas/GenericRemoteError","kind":"json-schema","title":"GenericRemoteError","data":{"oneOf":[{"type":"null"},{"type":"object","properties":{"autoMerge":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the auto merge failure."},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of the error."},"buildId":{"type":"string","description":"ID of the build that triggered the auto merge."}},"required":["message","timestamp"]}},"required":["autoMerge"]}],"readOnly":true}},"components/schemas/LastSyncedAt":{"id":"components/schemas/LastSyncedAt","kind":"json-schema","title":"LastSyncedAt","data":{"type":["string","null"],"format":"date-time","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Last time remote processed the default branch update."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," when the remote has never been synced."," ","For URL remotes it is updated on interval specified for the remote."]}]},"example":"2021-08-25T10:00:00.000Z"}},"components/schemas/SyncAttempts":{"id":"components/schemas/SyncAttempts","kind":"json-schema","title":"SyncAttempts","data":{"type":"integer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Number of failed attempts to sync the remote. If this value exceeds ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["6"]},", automatic synchronization is disabled."]}]},"example":1}},"components/schemas/UrlRemote":{"id":"components/schemas/UrlRemote","kind":"json-schema","title":"UrlRemote","data":{"type":"object","required":["id","type","mountPath","mountBranchName","createdAt","updatedAt","editedAt","createdById","editedById","contentType","url","fileName","object","uri"],"properties":{"id":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remote ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rem_"]},"."]}]},"type":"string","pattern":"^rem_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"rem_01h1s5z6vf2mm1mz3hevnn9va7","readOnly":true},"type":{"type":"string","const":"URL"},"mountPath":{"$ref":"#/components/schemas/MountPath"},"autoSync":{"$ref":"#/components/schemas/AutoSync"},"autoSyncDisabledAt":{"$ref":"#/components/schemas/AutoSyncDisabledAt"},"autoMerge":{"$ref":"#/components/schemas/AutoMerge"},"createdAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"updatedAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"editedAt":{"description":"Date and time of upserting Remote by user.","type":["string","null"],"readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"createdById":{"description":"User ID who created Remote.","type":["string","null"],"example":"usr_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"editedById":{"description":"User who recently upserted Remote.","type":["string","null"],"example":"usr_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"lastSyncedAt":{"$ref":"#/components/schemas/LastSyncedAt"},"attempts":{"$ref":"#/components/schemas/SyncAttempts"},"providerType":{"type":"null","readOnly":true},"namespaceId":{"type":"null","readOnly":true},"repositoryId":{"type":"null","readOnly":true},"mountBranchName":{"$ref":"#/components/schemas/MountBranchName"},"contentPath":{"type":"null","readOnly":true},"credentialId":{"type":"null","readOnly":true},"branchName":{"type":"null","readOnly":true},"contentType":{"type":"string","enum":["FOLDER","FILE"]},"url":{"description":"URL to the remote content.","type":"string","example":"https://raw.githubusercontent.com/Redocly/museum-openapi-example/main/openapi.yaml"},"interval":{"type":"number","description":"Interval in seconds to sync URL remote content.","minimum":900,"default":1800,"example":900},"fileName":{"type":"string","description":"File name of the remote content.","example":"openapi.yaml"},"object":{"description":"Entity name.","type":"string","enum":["remote"],"readOnly":true},"lastFinishedUrlUpdateId":{"type":["string","null"],"description":"ID of the last finished URL update.","example":"grupd_01jw8fczg4n4fcwkkg0nac3ddh","readOnly":true},"errors":{"$ref":"#/components/schemas/GenericRemoteError"},"uri":{"type":"string","format":"uri","description":"Canonical URI for the URL remote resource.","readOnly":true,"example":"https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/remotes/rem_01h1s5z6vf2mm1mz3hevnn9va7"}}}},"components/schemas/CicdRemote":{"id":"components/schemas/CicdRemote","kind":"json-schema","title":"CicdRemote","data":{"type":"object","required":["id","type","mountPath","mountBranchName","createdAt","updatedAt","editedAt","createdById","editedById","object","uri"],"properties":{"id":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remote ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rem_"]},"."]}]},"type":"string","pattern":"^rem_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"rem_01h1s5z6vf2mm1mz3hevnn9va7","readOnly":true},"type":{"type":"string","const":"CICD"},"mountPath":{"$ref":"#/components/schemas/MountPath"},"autoSync":{"$ref":"#/components/schemas/AutoSync"},"autoMerge":{"$ref":"#/components/schemas/AutoMerge"},"createdAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"updatedAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"editedAt":{"description":"Date and time of upserting Remote by user.","type":["string","null"],"readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"createdById":{"description":"User ID who created Remote.","type":["string","null"],"example":"usr_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"editedById":{"description":"User who recently upserted Remote.","type":["string","null"],"example":"usr_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"lastSyncedAt":{"$ref":"#/components/schemas/LastSyncedAt"},"providerType":{"type":"null","readOnly":true},"namespaceId":{"type":"null","readOnly":true},"repositoryId":{"type":"null","readOnly":true},"mountBranchName":{"$ref":"#/components/schemas/MountBranchName"},"contentPath":{"type":"null","readOnly":true},"credentialId":{"type":"null","readOnly":true},"branchName":{"type":"null","readOnly":true},"contentType":{"type":"null","readOnly":true},"url":{"type":"null","readOnly":true},"interval":{"type":"null","readOnly":true},"errors":{"$ref":"#/components/schemas/GenericRemoteError"},"object":{"description":"Entity name.","type":"string","enum":["remote"],"readOnly":true},"uri":{"type":"string","format":"uri","description":"Canonical URI for the CICD remote resource.","readOnly":true,"example":"https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/remotes/rem_01h1s5z6vf2mm1mz3hevnn9va7"}}}},"components/schemas/PushProjectBuildStatus":{"id":"components/schemas/PushProjectBuildStatus","kind":"json-schema","title":"PushProjectBuildStatus","data":{"type":"object","required":["deploy","scorecard"],"properties":{"deploy":{"type":"object","properties":{"url":{"type":["string","null"],"description":"Deployment URL."},"status":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Final status of the project deployment."," ","It includes the build result, the checks that block the publish (link checker"," ","and scorecard, unless the project config ignores them), and the deployment result."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]},": the build fails, a check blocks the publish, or the deployment fails."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped"]},": the deployment does not run, for example because the preview fails"," ","or a newer build replaces it."]}]},"enum":["pending","running","success","failed","skipped"],"example":"running"}},"required":["status","url"]},"scorecard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Scorecard name.","example":"Scorecard: Compliance API"},"status":{"type":"string","enum":["pending","running","success","failed"]},"description":{"type":"string","description":"Scorecard status description."},"url":{"type":"string","description":"Scorecard URL."}},"required":["name","status","description","url"]}},"linkCheck":{"type":"object","description":"Link checker status. Omitted when the link check has not run.","properties":{"name":{"type":"string","description":"Link check name.","example":"Link checker"},"status":{"type":"string","enum":["pending","running","success","failed"]},"description":{"type":"string","description":"Link check status description.","example":"Detected 2 broken links"},"url":{"type":"string","description":"Link check results URL."}},"required":["name","status","description","url"]}}}},"components/schemas/Push":{"id":"components/schemas/Push","kind":"json-schema","title":"Push","data":{"type":"object","required":["id","remoteIds","commit","uploadedFiles","isOutdated","hasChanges","status"],"properties":{"id":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Push ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push_"]},"."]}]},"type":"string","pattern":"^push_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"push_01h2captefvs9bpg3v6twqqj9n","readOnly":true},"object":{"description":"Entity name.","type":"string","enum":["push"],"readOnly":true},"remoteIds":{"type":"array","items":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remote IDs. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rem_"]}," for pushed remotes."]}]},"pattern":"^rem_[0-9abcdefghjkmnpqrstvwxyz]{26}$"}},"remoteId":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remote ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rem_"]}," for pushed remotes. Used only for single remote push."]}]},"pattern":"^rem_[0-9abcdefghjkmnpqrstvwxyz]{26}$","deprecated":true},"commit":{"type":"object","required":["message","branchName","author"],"description":"Commit details.","properties":{"message":{"type":"string","description":"Commit message.","example":"chore: Add new API"},"branchName":{"type":"string","description":"Branch name.","example":"main"},"sha":{"type":["string","null"],"description":"SHA of the commit.","example":"f64ae8ea9dd7cf28822c471ea56b6d6765971305"},"url":{"type":["string","null"],"format":"uri","description":"Commit URL.","example":"https://gitlab.com/example-user/example-project/-/commit/f64ae8ea9dd7cf28822c471ea56b6d6765971305"},"createdAt":{"type":["string","null"],"format":"date-time","description":"Commit creation date.","example":"2020-01-01T00:00:00.000Z"},"namespaceId":{"type":["string","null"],"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Git namespace ID (organization login for GitHub)."]}]},"example":"Redocly"},"repositoryId":{"type":["string","null"],"description":"Git repository ID.","example":"redoc"},"author":{"description":"Commit author details.","type":"object","required":["email","name"],"properties":{"name":{"description":"Commit author name.","example":"John Doe"},"email":{"type":"string","description":"Commit author email.","format":"email","example":"johndoe@example.com"},"image":{"type":["string","null"],"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Commit author image URL."," ","If not provided, the default image is used."," ","If the image is not accessible, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs"},"children":["data URL"]}," can be used."]}]}}}},"statuses":{"type":"array","readOnly":true,"description":"List of commit statuses set by the platform to the commit that triggered push.","items":{"type":"object","properties":{"name":{"type":"string","description":"Commit status name.","example":"Scorecard: Compliance API (org-slug/project-slug/remote-mount-path (remote))"},"status":{"type":"string","enum":["pending","running","success","failed"]},"description":{"type":"string","description":"Commit status description."},"url":{"type":["string","null"],"description":"Commit status URL."}},"required":["name","status","description","url"]}}}},"scoutJobId":{"type":["string","null"],"pattern":"^job_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROCESS_GIT_REPO"]}," job, if any. Required for Scout pushes. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["job_"]},"."]}]},"example":"job_01h2captefvs9bpg3v6twqqj9n"},"scoutJobContext":{"type":"string","writeOnly":true,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Context of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROCESS_GIT_REPO"]}," job, if any."," ","Applies to Scout pushes only."," ","Used as commit status context."]}]},"example":"Team A"},"replace":{"type":"boolean","description":"Whether to replace the existing files.\nIf provided, all files from the remote are removed and the new files are added.\nIf not provided, the existing files are kept and the new files are added, overwriting the existing files where they overlap.","example":true,"default":false},"files":{"type":"object","writeOnly":true,"description":"Map of files to upload.","additionalProperties":{"description":"Files to push.","type":"string","format":"binary"}},"uploadedFiles":{"type":"array","readOnly":true,"description":"List of pushed files.","items":{"type":"object","description":"Pushed file.","required":["path","mimeType"],"properties":{"path":{"type":"string","description":"File path.","example":"some-path/index.html"},"mimeType":{"type":"string","description":"File MIME type.","example":"text/html"}}}},"isMainBranch":{"type":"boolean","example":true,"description":"Is push provided to the main branch."},"isOutdated":{"type":"boolean","readOnly":true,"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Indicates whether the push is discarded."," ","In case several pushes are performed in a row, the one with most recent commit is applied only."," ","Always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," when commit's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAt"]}," is omitted."]}]},"example":false},"hasChanges":{"type":"boolean","readOnly":true,"description":"Indicates if pushed files have changes.","example":false},"status":{"type":"object","readOnly":true,"description":"Status of the corresponding preview and production builds.","required":["preview","production"],"properties":{"preview":{"$ref":"#/components/schemas/PushProjectBuildStatus"},"production":{"$ref":"#/components/schemas/PushProjectBuildStatus"}}}}}},"components/schemas/PushList":{"id":"components/schemas/PushList","kind":"json-schema","title":"PushList","data":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"page":{"$ref":"#/components/schemas/Page"},"data":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Push"}}},"required":["object","page","data"]}},"components/schemas/GitRemote":{"id":"components/schemas/GitRemote","kind":"json-schema","title":"GitRemote","data":{"type":"object","required":["id","type","mountPath","mountBranchName","createdAt","updatedAt","editedAt","createdById","editedById","repositoryId","branchName","contentPath","contentType","providerType","credentialId","uri","object"],"properties":{"id":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remote ID. Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rem_"]},"."]}]},"type":"string","pattern":"^rem_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"rem_01h1s5z6vf2mm1mz3hevnn9va7","readOnly":true},"type":{"type":"string","const":"GIT"},"mountPath":{"$ref":"#/components/schemas/MountPath"},"autoSync":{"$ref":"#/components/schemas/AutoSync"},"autoSyncDisabledAt":{"$ref":"#/components/schemas/AutoSyncDisabledAt"},"autoMerge":{"$ref":"#/components/schemas/AutoMerge"},"createdAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"updatedAt":{"type":"string","readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"editedAt":{"description":"Time when a user last created or updated the remote.","type":["string","null"],"readOnly":true,"examples":["2023-06-07T00:00:00Z"],"format":"date-time"},"createdById":{"description":"ID of the user who created the remote.","type":["string","null"],"example":"usr_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"editedById":{"description":"ID of the user who last created or updated the remote.","type":["string","null"],"example":"usr_01hh1t9sa6gwfv5naz04gr7ehm","readOnly":true},"lastSyncedAt":{"$ref":"#/components/schemas/LastSyncedAt"},"attempts":{"$ref":"#/components/schemas/SyncAttempts"},"providerType":{"$ref":"#/components/schemas/GitProviderType"},"namespaceId":{"description":"Git provider namespace of the repository, such as a GitHub organization or an Azure DevOps project.","type":["string","null"]},"repositoryId":{"description":"Git provider identifier of the repository.","type":"string"},"mountBranchName":{"$ref":"#/components/schemas/MountBranchName"},"contentPath":{"description":"Path to the connected folder in the remote repository.","type":"string"},"credentialId":{"type":"string","pattern":"^cred_[0-9abcdefghjkmnpqrstvwxyz]{26}$","example":"cred_01hc2rvwxf7jyj1er504khx8e7","description":"ID of the credential Redocly uses to access the repository.\nUse it to rotate the access token of the credential."},"branchName":{"description":"Branch name in the remote repository.","type":"string","example":"dev"},"contentType":{"type":"string","enum":["FOLDER","FILE"],"example":"FILE"},"url":{"type":"null","readOnly":true},"interval":{"type":"null","readOnly":true},"object":{"description":"Entity name.","type":"string","enum":["remote"],"readOnly":true},"uri":{"description":"Canonical URI for the remote resource.","type":"string","format":"uri","readOnly":true,"example":"https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/remotes/rem_01h1s5z6vf2mm1mz3hevnn9va7"},"lastFinishedGitUpdateId":{"type":["string","null"],"description":"ID of the last finished Git update.","readOnly":true,"example":"grupd_01jw8fczg4n4fcwkkg0nac3ddh"},"errors":{"$ref":"#/components/schemas/GenericRemoteError"}}}},"components/schemas/Remote":{"id":"components/schemas/Remote","kind":"json-schema","title":"Remote","data":{"oneOf":[{"$ref":"#/components/schemas/GitRemote"},{"$ref":"#/components/schemas/UrlRemote"},{"$ref":"#/components/schemas/CicdRemote"}],"discriminator":{"propertyName":"type","mapping":{"GIT":"#/components/schemas/GitRemote","URL":"#/components/schemas/UrlRemote","CICD":"#/components/schemas/CicdRemote"}}}},"components/schemas/RemoteList":{"id":"components/schemas/RemoteList","kind":"json-schema","title":"RemoteList","data":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"page":{"$ref":"#/components/schemas/Page"},"data":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Remote"}}},"required":["object","page","data"]}},"schema_0":{"kind":"json-schema","data":{"type":"string","pattern":"^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org_"]},"."]}]}},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","enum":["json","csv"],"default":"json"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-z0-9-]{1,64}/[\\w.+-]{1,32}$"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"integer","minimum":1,"description":"Number of seconds to wait before sending another request.","example":30}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","pattern":"^exp_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exp_"]},"."]}]}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogExportEvent"}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Attachment hint for browsers and HTTP clients. Suggested filename: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{exportJobId}.json"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{exportJobId}.csv"]},"."]}]},"example":"attachment; filename=\"exp_01hh1t9sa6gwfv5naz04gr7ehm.json\""}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","pattern":"^prj_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prj_"]},"."]}]}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","default":"-id"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","pattern":"^fb_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fb_"]},"."]}]}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","enum":["csv","json"],"default":"csv"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":10000,"default":1000},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Attachment hint for browsers and HTTP clients."," ","Includes the suggested filename in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filename"]}," parameter (quoted)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default the filename follows ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["feedback_export_{orgId}_{projectId}_{timestamp}.{format}"]},", using the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orgId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectId"]}," as in the path and a millisecond timestamp."]}]},"example":"attachment; filename=\"feedback_export_org_01hh1t9sa6gwfv5naz04gr7ehm_prj_01hh1t9sa6gwfv5naz04gr7ehm_1715432100123.csv\""}}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","pattern":"^rem_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rem_"]},"."]}]}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","pattern":"^push_[0-9abcdefghjkmnpqrstvwxyz]{26}$","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unique identifier prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push_"]},"."]}]}},"id":"schema_18"}},"exampleStore":{"paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/responses/201/content/application~1json/example":{"value":{"id":"exp_01hh1t9sa6gwfv5naz04gr7ehm","createdAt":"2024-01-15T12:00:00.000Z"},"id":"paths/~1orgs~1{orgId}~1audit-log-export-jobs/post/responses/201/content/application~1json/example"},"paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/responses/200/content/application~1json/example":{"value":{"id":"exp_01hh1t9sa6gwfv5naz04gr7ehm","status":"COMPLETED","createdAt":"2024-01-15T12:00:00.000Z"},"id":"paths/~1orgs~1{orgId}~1audit-log-export-jobs~1{exportJobId}/get/responses/200/content/application~1json/example"},"paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/application~1json/example":{"value":[{"id":"evt_2fxb8r4kq7m3ndp9z6ja501","object":"event","type":"com.redocly.pullRequest.created","time":"2026-03-31T15:27:30.815Z","subject":"pr_7wnk3jm9xp2d4rv8qh5a01","actor":{"id":"usr_01h2r5f6qy8kr42p8yfw52spq6","object":"user","uri":"https://app.cloud.redocly.com/api/users/usr_01h2r5f6qy8kr42p8yfw52spq6"},"clientIp":"198.51.100.42","projectId":"prj_01hh1t9sa6gwfv5naz04gr7ehm","projectSlug":"my-project"}],"id":"paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/application~1json/example"},"paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/text~1csv/example":{"value":"id,object,type,time,subject,actor,clientIp,projectId,projectSlug\nevt_2fxb8r4kq7m3ndp9z6ja501,event,com.redocly.pullRequest.created,2026-03-31T15:27:30.815Z,pr_7wnk3jm9xp2d4rv8qh5a01,\"{\"\"id\"\":\"\"usr_01h2r5f6qy8kr42p8yfw52spq6\"\",\"\"object\"\":\"\"user\"\",\"\"uri\"\":\"\"https://app.cloud.redocly.com/api/users/usr_01h2r5f6qy8kr42p8yfw52spq6\"\"}\",198.51.100.42,prj_01hh1t9sa6gwfv5naz04gr7ehm,my-project\n","id":"paths/~1orgs~1{orgId}~1audit-log-export-results~1{exportJobId}/get/responses/200/content/text~1csv/example"}},"securitySchemeStore":{"ApiKey":{"id":"ApiKey","type":"http","scheme":"bearer","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API key is required to access API."," ","Create an API key by visiting ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.cloud.redocly.com/"},"children":["Platform"]}," and navigating to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]}]}}},"specVersion":"3.1.0","info":{"version":"1.0.1","title":"Redocly platform","termsOfService":"https://redocly.com/subscription-agreement","contact":{"name":"API Support","email":"team@redocly.com","url":"https://github.com/Redocly/redocly"},"license":{"name":"Redocly","url":"https://redocly.com/subscription-agreement"}},"servers":[{"url":"/_mock/docs/platform/customization/reunite-api/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://app.cloud.redocly.com/api","description":"Production main server."},{"url":"https://app.cloud.eu.redocly.com/api","description":"Production EU server."}],"specType":"openapi"},"options":{"excludeFromSearch":true,"downloadUrls":[{"url":"/_bundle/docs/platform/customization/reunite-api/openapi.json?download","title":"openapi.json"},{"url":"/_bundle/docs/platform/customization/reunite-api/openapi.yaml?download","title":"openapi.yaml"}],"replayDefinitionUrl":"/_bundle/docs/platform/customization/reunite-api/openapi.json?download","mockServer":{"url":"/_mock/docs/platform/customization/reunite-api/openapi","position":"first","description":"Mock server"},"feedback":{"type":"sentiment","settings":{"comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"},"label":"Was this section helpful?"}}},"specType":"openapi","basePath":"/docs/platform/customization/reunite-api/openapi","title":"Redocly platform","metadata":{}}