openapi: 3.1.0 info: version: 3.0.0 title: Escape Public Asm Integrations API description: 'This API enables you to operate [Escape](https://escape.tech/) programmatically. All requests must be authenticated with a valid API key, provided in the `X-ESCAPE-API-KEY` header. For example: `X-ESCAPE-API-KEY: YOUR_API_KEY`. You can find your API key in the [Escape dashboard](https://app.escape.tech/user/).' servers: - url: https://public.escape.tech/v3 security: - apiKey: [] tags: - name: Integrations description: 'Manage 3rd party integrations. The public API provide basic CRUDs operations for all available integrations. See [our documentation](https://https://docs.escape.tech/documentation/asm/integrations/) for more details.' paths: /integrations/akamai: get: tags: - Integrations summary: List Akamai integrations. operationId: listakamaiIntegrations description: List and search Akamai integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Akamai integrations. operationId: createakamaiIntegration description: Create a Akamai integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: client_secret: type: string host: type: string access_token: type: string client_token: type: string required: - client_secret - host - access_token - client_token description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_secret: type: string host: type: string access_token: type: string client_token: type: string required: - client_secret - host - access_token - client_token description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/akamai/{id}: get: tags: - Integrations summary: Get Akamai integration. operationId: getakamaiIntegration description: Get a Akamai integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_secret: type: string host: type: string access_token: type: string client_token: type: string required: - client_secret - host - access_token - client_token description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Akamai integration. operationId: updateakamaiIntegration description: Update a Akamai integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: client_secret: type: string host: type: string access_token: type: string client_token: type: string required: - client_secret - host - access_token - client_token description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_secret: type: string host: type: string access_token: type: string client_token: type: string required: - client_secret - host - access_token - client_token description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Akamai integration. operationId: deleteakamaiIntegration description: Delete a Akamai integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_secret: type: string host: type: string access_token: type: string client_token: type: string required: - client_secret - host - access_token - client_token description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/aws: get: tags: - Integrations summary: List AWS integrations. operationId: listawsIntegrations description: List and search AWS integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create AWS integrations. operationId: createawsIntegration description: Create a AWS integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: public_key: type: string private_key: type: string required: - public_key - private_key description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: public_key: type: string private_key: type: string required: - public_key - private_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/aws/{id}: get: tags: - Integrations summary: Get AWS integration. operationId: getawsIntegration description: Get a AWS integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: public_key: type: string private_key: type: string required: - public_key - private_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update AWS integration. operationId: updateawsIntegration description: Update a AWS integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: public_key: type: string private_key: type: string required: - public_key - private_key description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: public_key: type: string private_key: type: string required: - public_key - private_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete AWS integration. operationId: deleteawsIntegration description: Delete a AWS integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: public_key: type: string private_key: type: string required: - public_key - private_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/azure: get: tags: - Integrations summary: List Azure integrations. operationId: listazureIntegrations description: List and search Azure integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Azure integrations. operationId: createazureIntegration description: Create a Azure integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: client_id: type: string client_secret: type: string tenant_id: type: string subscription_id: type: string required: - client_id - client_secret - tenant_id description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string tenant_id: type: string subscription_id: type: string required: - client_id - client_secret - tenant_id description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/azure/{id}: get: tags: - Integrations summary: Get Azure integration. operationId: getazureIntegration description: Get a Azure integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string tenant_id: type: string subscription_id: type: string required: - client_id - client_secret - tenant_id description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Azure integration. operationId: updateazureIntegration description: Update a Azure integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: client_id: type: string client_secret: type: string tenant_id: type: string subscription_id: type: string required: - client_id - client_secret - tenant_id description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string tenant_id: type: string subscription_id: type: string required: - client_id - client_secret - tenant_id description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Azure integration. operationId: deleteazureIntegration description: Delete a Azure integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string tenant_id: type: string subscription_id: type: string required: - client_id - client_secret - tenant_id description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/bitbucket: get: tags: - Integrations summary: List Bitbucket integrations. operationId: listbitbucketIntegrations description: List and search Bitbucket integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Bitbucket integrations. operationId: createbitbucketIntegration description: Create a Bitbucket integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: email: type: string api_key: type: string workspace_slug: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - email - api_key - workspace_slug description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: email: type: string api_key: type: string workspace_slug: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - email - api_key - workspace_slug description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/bitbucket/{id}: get: tags: - Integrations summary: Get Bitbucket integration. operationId: getbitbucketIntegration description: Get a Bitbucket integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: email: type: string api_key: type: string workspace_slug: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - email - api_key - workspace_slug description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Bitbucket integration. operationId: updatebitbucketIntegration description: Update a Bitbucket integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: email: type: string api_key: type: string workspace_slug: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - email - api_key - workspace_slug description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: email: type: string api_key: type: string workspace_slug: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - email - api_key - workspace_slug description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Bitbucket integration. operationId: deletebitbucketIntegration description: Delete a Bitbucket integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: email: type: string api_key: type: string workspace_slug: type: string instance_url: type: - string - 'null' location_id: type: - string - 'null' required: - email - api_key - workspace_slug description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/cloudflare: get: tags: - Integrations summary: List Cloudflare integrations. operationId: listcloudflareIntegrations description: List and search Cloudflare integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Cloudflare integrations. operationId: createcloudflareIntegration description: Create a Cloudflare integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/cloudflare/{id}: get: tags: - Integrations summary: Get Cloudflare integration. operationId: getcloudflareIntegration description: Get a Cloudflare integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Cloudflare integration. operationId: updatecloudflareIntegration description: Update a Cloudflare integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Cloudflare integration. operationId: deletecloudflareIntegration description: Delete a Cloudflare integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/custom: get: tags: - Integrations summary: List Custom Integration integrations. operationId: listcustomIntegrations description: List and search Custom Integration integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Custom Integration integrations. operationId: createcustomIntegration description: Create a Custom Integration integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: identifier: type: string parameters: {} required: - identifier description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: identifier: type: string parameters: {} required: - identifier description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/custom/{id}: get: tags: - Integrations summary: Get Custom Integration integration. operationId: getcustomIntegration description: Get a Custom Integration integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: identifier: type: string parameters: {} required: - identifier description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Custom Integration integration. operationId: updatecustomIntegration description: Update a Custom Integration integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: identifier: type: string parameters: {} required: - identifier description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: identifier: type: string parameters: {} required: - identifier description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Custom Integration integration. operationId: deletecustomIntegration description: Delete a Custom Integration integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: identifier: type: string parameters: {} required: - identifier description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/gcp: get: tags: - Integrations summary: List GCP integrations. operationId: listgcpIntegrations description: List and search GCP integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create GCP integrations. operationId: creategcpIntegration description: Create a GCP integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: auth_provider_x509_cert_url: type: string auth_uri: type: string client_email: type: string client_id: type: string client_x509_cert_url: type: string private_key: type: string private_key_id: type: string project_id: type: string projects: type: string token_uri: type: string type: type: string universe_domain: type: string required: - auth_provider_x509_cert_url - auth_uri - client_email - client_id - client_x509_cert_url - private_key - private_key_id - project_id - token_uri - type - universe_domain description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: auth_provider_x509_cert_url: type: string auth_uri: type: string client_email: type: string client_id: type: string client_x509_cert_url: type: string private_key: type: string private_key_id: type: string project_id: type: string projects: type: string token_uri: type: string type: type: string universe_domain: type: string required: - auth_provider_x509_cert_url - auth_uri - client_email - client_id - client_x509_cert_url - private_key - private_key_id - project_id - token_uri - type - universe_domain description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/gcp/{id}: get: tags: - Integrations summary: Get GCP integration. operationId: getgcpIntegration description: Get a GCP integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: auth_provider_x509_cert_url: type: string auth_uri: type: string client_email: type: string client_id: type: string client_x509_cert_url: type: string private_key: type: string private_key_id: type: string project_id: type: string projects: type: string token_uri: type: string type: type: string universe_domain: type: string required: - auth_provider_x509_cert_url - auth_uri - client_email - client_id - client_x509_cert_url - private_key - private_key_id - project_id - token_uri - type - universe_domain description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update GCP integration. operationId: updategcpIntegration description: Update a GCP integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: auth_provider_x509_cert_url: type: string auth_uri: type: string client_email: type: string client_id: type: string client_x509_cert_url: type: string private_key: type: string private_key_id: type: string project_id: type: string projects: type: string token_uri: type: string type: type: string universe_domain: type: string required: - auth_provider_x509_cert_url - auth_uri - client_email - client_id - client_x509_cert_url - private_key - private_key_id - project_id - token_uri - type - universe_domain description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: auth_provider_x509_cert_url: type: string auth_uri: type: string client_email: type: string client_id: type: string client_x509_cert_url: type: string private_key: type: string private_key_id: type: string project_id: type: string projects: type: string token_uri: type: string type: type: string universe_domain: type: string required: - auth_provider_x509_cert_url - auth_uri - client_email - client_id - client_x509_cert_url - private_key - private_key_id - project_id - token_uri - type - universe_domain description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete GCP integration. operationId: deletegcpIntegration description: Delete a GCP integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: auth_provider_x509_cert_url: type: string auth_uri: type: string client_email: type: string client_id: type: string client_x509_cert_url: type: string private_key: type: string private_key_id: type: string project_id: type: string projects: type: string token_uri: type: string type: type: string universe_domain: type: string required: - auth_provider_x509_cert_url - auth_uri - client_email - client_id - client_x509_cert_url - private_key - private_key_id - project_id - token_uri - type - universe_domain description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/github: get: tags: - Integrations summary: List GitHub integrations. operationId: listgithubIntegrations description: List and search GitHub integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create GitHub integrations. operationId: creategithubIntegration description: Create a GitHub integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/github/{id}: get: tags: - Integrations summary: Get GitHub integration. operationId: getgithubIntegration description: Get a GitHub integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update GitHub integration. operationId: updategithubIntegration description: Update a GitHub integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete GitHub integration. operationId: deletegithubIntegration description: Delete a GitHub integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/gitlab: get: tags: - Integrations summary: List GitLab integrations. operationId: listgitlabIntegrations description: List and search GitLab integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create GitLab integrations. operationId: creategitlabIntegration description: Create a GitLab integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: api_key: type: string instance_url: type: string required: - api_key description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string instance_url: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/gitlab/{id}: get: tags: - Integrations summary: Get GitLab integration. operationId: getgitlabIntegration description: Get a GitLab integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string instance_url: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update GitLab integration. operationId: updategitlabIntegration description: Update a GitLab integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: api_key: type: string instance_url: type: string required: - api_key description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string instance_url: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete GitLab integration. operationId: deletegitlabIntegration description: Delete a GitLab integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string instance_url: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/jira: get: tags: - Integrations summary: List Jira integrations. operationId: listjiraIntegrations description: List and search Jira integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Jira integrations. operationId: createjiraIntegration description: Create a Jira integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: name: type: string account_id: type: string instance_url: type: string auth_method: type: string enum: - cloud - server email: type: string api_key: type: string username: type: string password: type: string proxy_id: type: string templates: type: array items: type: object properties: name: type: string project_id: type: string issue_type: type: string properties_mapping: type: array items: type: object properties: name: type: string mapping: type: array items: type: object properties: escape_property: type: string enum: - severity - applicationName - context - testCategory - scanId - linkToEscape jira_property: type: string escape_option: type: string jira_option: type: string required: - escape_property - jira_property required: - name - mapping parent_key: type: string required: - name - project_id - issue_type required: - name - account_id - instance_url - auth_method description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: name: type: string account_id: type: string instance_url: type: string auth_method: type: string enum: - cloud - server email: type: string api_key: type: string username: type: string password: type: string proxy_id: type: string templates: type: array items: type: object properties: name: type: string project_id: type: string issue_type: type: string properties_mapping: type: array items: type: object properties: name: type: string mapping: type: array items: type: object properties: escape_property: type: string enum: - severity - applicationName - context - testCategory - scanId - linkToEscape jira_property: type: string escape_option: type: string jira_option: type: string required: - escape_property - jira_property required: - name - mapping parent_key: type: string required: - name - project_id - issue_type required: - name - account_id - instance_url - auth_method description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/jira/{id}: get: tags: - Integrations summary: Get Jira integration. operationId: getjiraIntegration description: Get a Jira integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: name: type: string account_id: type: string instance_url: type: string auth_method: type: string enum: - cloud - server email: type: string api_key: type: string username: type: string password: type: string proxy_id: type: string templates: type: array items: type: object properties: name: type: string project_id: type: string issue_type: type: string properties_mapping: type: array items: type: object properties: name: type: string mapping: type: array items: type: object properties: escape_property: type: string enum: - severity - applicationName - context - testCategory - scanId - linkToEscape jira_property: type: string escape_option: type: string jira_option: type: string required: - escape_property - jira_property required: - name - mapping parent_key: type: string required: - name - project_id - issue_type required: - name - account_id - instance_url - auth_method description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Jira integration. operationId: updatejiraIntegration description: Update a Jira integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: name: type: string account_id: type: string instance_url: type: string auth_method: type: string enum: - cloud - server email: type: string api_key: type: string username: type: string password: type: string proxy_id: type: string templates: type: array items: type: object properties: name: type: string project_id: type: string issue_type: type: string properties_mapping: type: array items: type: object properties: name: type: string mapping: type: array items: type: object properties: escape_property: type: string enum: - severity - applicationName - context - testCategory - scanId - linkToEscape jira_property: type: string escape_option: type: string jira_option: type: string required: - escape_property - jira_property required: - name - mapping parent_key: type: string required: - name - project_id - issue_type required: - name - account_id - instance_url - auth_method description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: name: type: string account_id: type: string instance_url: type: string auth_method: type: string enum: - cloud - server email: type: string api_key: type: string username: type: string password: type: string proxy_id: type: string templates: type: array items: type: object properties: name: type: string project_id: type: string issue_type: type: string properties_mapping: type: array items: type: object properties: name: type: string mapping: type: array items: type: object properties: escape_property: type: string enum: - severity - applicationName - context - testCategory - scanId - linkToEscape jira_property: type: string escape_option: type: string jira_option: type: string required: - escape_property - jira_property required: - name - mapping parent_key: type: string required: - name - project_id - issue_type required: - name - account_id - instance_url - auth_method description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Jira integration. operationId: deletejiraIntegration description: Delete a Jira integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: name: type: string account_id: type: string instance_url: type: string auth_method: type: string enum: - cloud - server email: type: string api_key: type: string username: type: string password: type: string proxy_id: type: string templates: type: array items: type: object properties: name: type: string project_id: type: string issue_type: type: string properties_mapping: type: array items: type: object properties: name: type: string mapping: type: array items: type: object properties: escape_property: type: string enum: - severity - applicationName - context - testCategory - scanId - linkToEscape jira_property: type: string escape_option: type: string jira_option: type: string required: - escape_property - jira_property required: - name - mapping parent_key: type: string required: - name - project_id - issue_type required: - name - account_id - instance_url - auth_method description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/kubernetes: get: tags: - Integrations summary: List Kubernetes integrations. operationId: listkubernetesIntegrations description: List and search Kubernetes integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Kubernetes integrations. operationId: createkubernetesIntegration description: Create a Kubernetes integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: blacklist: type: - object - 'null' properties: namespaces: type: - array - 'null' items: type: string tags: type: - object - 'null' properties: labels: type: - array - 'null' items: type: string namespaces: type: - boolean - 'null' description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: blacklist: type: - object - 'null' properties: namespaces: type: - array - 'null' items: type: string tags: type: - object - 'null' properties: labels: type: - array - 'null' items: type: string namespaces: type: - boolean - 'null' description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/kubernetes/{id}: get: tags: - Integrations summary: Get Kubernetes integration. operationId: getkubernetesIntegration description: Get a Kubernetes integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: blacklist: type: - object - 'null' properties: namespaces: type: - array - 'null' items: type: string tags: type: - object - 'null' properties: labels: type: - array - 'null' items: type: string namespaces: type: - boolean - 'null' description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Kubernetes integration. operationId: updatekubernetesIntegration description: Update a Kubernetes integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: blacklist: type: - object - 'null' properties: namespaces: type: - array - 'null' items: type: string tags: type: - object - 'null' properties: labels: type: - array - 'null' items: type: string namespaces: type: - boolean - 'null' description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: blacklist: type: - object - 'null' properties: namespaces: type: - array - 'null' items: type: string tags: type: - object - 'null' properties: labels: type: - array - 'null' items: type: string namespaces: type: - boolean - 'null' description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Kubernetes integration. operationId: deletekubernetesIntegration description: Delete a Kubernetes integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: blacklist: type: - object - 'null' properties: namespaces: type: - array - 'null' items: type: string tags: type: - object - 'null' properties: labels: type: - array - 'null' items: type: string namespaces: type: - boolean - 'null' description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/postman: get: tags: - Integrations summary: List Postman integrations. operationId: listpostmanIntegrations description: List and search Postman integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Postman integrations. operationId: createpostmanIntegration description: Create a Postman integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/postman/{id}: get: tags: - Integrations summary: Get Postman integration. operationId: getpostmanIntegration description: Get a Postman integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Postman integration. operationId: updatepostmanIntegration description: Update a Postman integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Postman integration. operationId: deletepostmanIntegration description: Delete a Postman integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: api_key: type: string required: - api_key description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request /integrations/wiz: get: tags: - Integrations summary: List Wiz integrations. operationId: listwizIntegrations description: List and search Wiz integrations of the organization. parameters: - schema: type: string description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5 required: false description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of items to return per page example: 50 required: false description: The number of items to return per page name: size in: query - schema: type: string enum: - NAME description: The type to sort by required: false description: The type to sort by name: sortType in: query - schema: type: string enum: - asc - desc default: asc description: The direction to sort by required: false description: The direction to sort by name: sortDirection in: query - schema: type: array items: type: string format: uuid description: Filter by project IDs required: false description: Filter by project IDs name: projectIds in: query - schema: type: array items: type: string format: uuid description: Filter by integration IDs required: false description: Filter by integration IDs name: ids in: query - schema: anyOf: - type: string - type: array items: type: string description: Filter by location IDs required: false description: Filter by location IDs name: locationIds in: query - schema: type: string description: Search term to filter integrations by name or description example: my integration required: false description: Search term to filter integrations by name or description name: search in: query responses: '200': description: OK content: application/json: schema: type: object properties: nextCursor: type: - string - 'null' totalCount: type: integer default: 100 example: 20 data: type: array items: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration location: type: - object - 'null' properties: id: type: string format: uuid description: The location ID. name: type: string description: The name of the location. type: type: string description: The type of the location. enabled: type: boolean description: Whether the location is enabled. lastSeenAt: type: - string - 'null' description: The date and time the location agent last connected. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - id - name - type - enabled - links title: LocationSummarized description: The location of the integration kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - projects - location - kind - valid - validationErrors required: - nextCursor - data '400': description: Pagination error content: application/json: schema: type: object properties: message: type: string enum: - Invalid cursor details: type: string required: - message - details title: PaginationError description: Returned when an invalid pagination cursor is supplied post: tags: - Integrations summary: Create Wiz integrations. operationId: createwizIntegration description: Create a Wiz integration. requestBody: content: application/json: schema: type: object properties: organizationId: type: string format: uuid description: The organization ID to create the integration for name: type: string description: The name of the integration parameters: type: object properties: client_id: type: string client_secret: type: string token_uri: type: string api_endpoint: type: string upload_severity_levels: type: - array - 'null' items: type: string enum: - None - Low - Medium - High - Critical required: - client_id - client_secret - token_uri - api_endpoint description: The parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to create the integration for example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to create the integration for example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 required: - name - parameters responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string token_uri: type: string api_endpoint: type: string upload_severity_levels: type: - array - 'null' items: type: string enum: - None - Low - Medium - High - Critical required: - client_id - client_secret - token_uri - api_endpoint description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation /integrations/wiz/{id}: get: tags: - Integrations summary: Get Wiz integration. operationId: getwizIntegration description: Get a Wiz integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string token_uri: type: string api_endpoint: type: string upload_severity_levels: type: - array - 'null' items: type: string enum: - None - Low - Medium - High - Critical required: - client_id - client_secret - token_uri - api_endpoint description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation put: tags: - Integrations summary: Update Wiz integration. operationId: updatewizIntegration description: Update a Wiz integration. parameters: - schema: type: string format: uuid description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path requestBody: content: application/json: schema: type: object properties: name: type: string description: The new name of the integration parameters: type: object properties: client_id: type: string client_secret: type: string token_uri: type: string api_endpoint: type: string upload_severity_levels: type: - array - 'null' items: type: string enum: - None - Low - Medium - High - Critical required: - client_id - client_secret - token_uri - api_endpoint description: The new parameters of the integration proxyId: type: string format: uuid description: Optional proxy ID to attach to the integration example: 00000000-0000-0000-0000-000000000000 projectIds: type: array items: type: string format: uuid description: Optional list of project IDs to attach to the integration example: - 00000000-0000-0000-0000-000000000000 - 00000000-0000-0000-0000-000000000001 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string token_uri: type: string api_endpoint: type: string upload_severity_levels: type: - array - 'null' items: type: string enum: - None - Low - Medium - High - Critical required: - client_id - client_secret - token_uri - api_endpoint description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation delete: tags: - Integrations summary: Delete Wiz integration. operationId: deletewizIntegration description: Delete a Wiz integration. parameters: - schema: type: string description: The integration ID example: 00000000-0000-0000-0000-000000000000 required: true description: The integration ID name: id in: path responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid description: The id of the integration name: type: string description: The name of the integration createdAt: type: string format: date-time description: The date and time the integration was created updatedAt: type: string format: date-time description: The date and time the integration was last updated scheduledForDeletionAt: type: - string - 'null' format: date-time description: The date and time the integration is scheduled for deletion lastPullWorkflowAt: type: - string - 'null' format: date-time description: The date and time the last pull workflow was executed kind: type: string enum: - AKAMAI - AWS - AZURE - BITBUCKET_REPO - CLOUDFLARE - CUSTOM - DISCORD_WEBHOOK - DNS - EMAIL - GCP - GITHUB_API_KEY - GITLAB_API_KEY - JIRA - KUBERNETES - POSTMAN_API_KEY - SLACK_WEBHOOK - TEAMS_WEBHOOK - WEBHOOK - WIZ description: The kind of the integration valid: type: boolean description: Whether the integration is valid validationErrors: type: array items: type: string description: The validation errors of the integration organizationId: type: string format: uuid description: The id of the organization the integration belongs to projects: type: array items: type: object properties: id: type: string format: uuid description: The id of the project name: type: string description: The name of the project createdAt: type: string format: date-time description: The date and time the project was created bindings: type: array items: type: object properties: id: type: string format: uuid description: The id of the role binding createdAt: type: string format: date-time description: The date and time the role binding was created roleId: type: string format: uuid description: The id of the role bound by the role binding projectId: type: - string - 'null' format: uuid description: The id of the project bound by the role binding userId: type: string format: uuid description: The id of the user bound by the role binding required: - id - createdAt - roleId - userId description: The bindings of the project required: - id - name - createdAt - bindings description: The projects of the integration parameters: type: object properties: client_id: type: string client_secret: type: string token_uri: type: string api_endpoint: type: string upload_severity_levels: type: - array - 'null' items: type: string enum: - None - Low - Medium - High - Critical required: - client_id - client_secret - token_uri - api_endpoint description: The parameters of the integration location: type: - object - 'null' properties: id: type: string format: uuid default: 00000000-0000-0000-0000-000000000000 description: The location ID. name: type: string default: Location Name description: The name of the location. type: type: string default: Location Type description: The type of the location. enabled: type: boolean default: true description: Whether the location is enabled. createdAt: type: string default: '2021-01-01T00:00:00Z' description: The date and time the location was created. lastSeenAt: type: - string - 'null' default: '2021-01-01T00:00:00Z' description: The date and time the location was last seen. links: type: object properties: locationOverview: type: string description: The URL of the location overview. required: - locationOverview required: - links title: LocationDetailed description: The location of the integration required: - id - name - createdAt - updatedAt - scheduledForDeletionAt - lastPullWorkflowAt - kind - valid - validationErrors - organizationId - projects - parameters - location '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string enum: - Bad Request details: type: string required: - message - details title: BadRequest description: Returned when the request payload fails validation '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string enum: - Internal Server Error details: type: string required: - message - details title: InternalServerError description: Returned when the server fails to fulfil the request components: securitySchemes: apiKey: type: apiKey in: header name: X-ESCAPE-API-KEY