Upwind Security events API
The Events resource offers a range of methods for listing, retrieving, and deleting events.
OpenAPI Specification
openapi: 3.1.0
info:
description: "## Overview\n\nThe Management REST API v1 represents a collection of endpoints designed for the execution of administrative tasks programmatically. Tailored for utilization by back-end servers or trusted entities, the API facilitates integration, data retrieval, and workflow automation.\n\nThe API provides a powerful set of tools to interact with your organization's resources, including [Threats](/restapi/v1/threats), [Vulnerabilities](/restapi/v1/vulnerabilities), [Configurations](/restapi/v1/configurations), and [Workflows](/restapi/v1/workflows). Whether you are building applications, integrating services, or exploring data, this documentation serves as your guide through the various endpoints and functionalities offered by our API.\n\nWhen you make a request to the API, you will specify an HTTP method and a path. Additionally, you might also specify request headers and path, query, or body parameters. The API will return the response status code, response headers, and potentially a response body.\n\nThe API reference documentation describes the HTTP method, path, and parameters for every operation. It also displays example requests and responses for each operation.\n\n## Authentication\n\nTo access the endpoints of the API, you need to authenticate your requests. We use OAuth 2.0, a widely adopted industry standard for authorization, to secure and control access to the API.\n\nThe API uses [JSON Web Tokens (JWTs)](https://datatracker.ietf.org/doc/html/rfc7519) access tokens to authenticate requests. The API access token's scopes claim indicates which request methods can be performed when calling the API. Trying to perform any request method not permitted within the set scopes will result in a **403 Forbidden** response.\n\nYou can authenticate your request by adding an access token in the [Authorization](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-bearer-20#section-2.1) HTTP header using the [Bearer authentication scheme](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-bearer-20). To obtain an access token, you must first obtain client credentials.\n\n### Obtaining client credentials\n\nBefore you can make requests to the API, you will need to obtain client credentials. Follow the steps in the [Generate New Credentials](/settings/credentials#generate-new-credentials) section of the [Credentials](/settings/credentials) page to generate a client ID and client secret unique to your application.\n\n### Obtaining access token\n\nNow that you have your client credentials, proceed with obtaining an access token. To get a token by using the client credentials grant, send a POST request to the OAuth 2.0 token endpoint URL (`/oauth/token`). All requests to the token endpoint should be an HTTP POST.\n\n:::important\nThe `audience` parameter in your token request must match the regional API endpoint you plan to use. This ensures your access token is valid for the correct region. An access token obtained with `audience=https://api.upwind.io` will only work with the US API endpoint and cannot be used with EU or ME endpoints.\n:::\n\n#### For US region\n```bash\ncurl --request POST \\\n --url \"https://auth.upwind.io/oauth/token\" \\\n --data-urlencode 'client_id=YOUR_CLIENT_ID' \\\n --data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \\\n --data-urlencode 'audience=https://api.upwind.io' \\\n --data-urlencode 'grant_type=client_credentials'\n```\n\n#### For EU region\n```bash\ncurl --request POST \\\n --url \"https://auth.upwind.io/oauth/token\" \\\n --data-urlencode 'client_id=YOUR_CLIENT_ID' \\\n --data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \\\n --data-urlencode 'audience=https://api.eu.upwind.io' \\\n --data-urlencode 'grant_type=client_credentials'\n```\n\n#### For ME region\n```bash\ncurl --request POST \\\n --url \"https://auth.upwind.io/oauth/token\" \\\n --data-urlencode 'client_id=YOUR_CLIENT_ID' \\\n --data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \\\n --data-urlencode 'audience=https://api.me.upwind.io' \\\n --data-urlencode 'grant_type=client_credentials'\n```\n\n:::warning\nTreat your access token like a password and consider using another service to store your token securely.\n:::\n\n### Authenticating\n\nOnce you have obtained an access token, you can authenticate your API requests by including it in the [Authorization](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-bearer-20#section-2.1) HTTP header using the [Bearer authentication scheme](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-bearer-20).\n\nFor example, to authenticate a request to list threat detections, include your access token in the `Authorization` header:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n## Requests\n\nTo make a request, first find the HTTP method and the path for the operation that you want to use. For example, the \"List Threat Detections\" operation uses the `GET` method and the `/threat-detections` path. For the full reference documentation for this operation, see [List Threat Detections](/restapi/v1/list-threat-detections).\n\nPrepend the base URL for the API to the path to get the full URL. Choose the appropriate regional endpoint:\n- **US**: `https://api.upwind.io`\n- **EU**: `https://api.eu.upwind.io`\n- **ME**: `https://api.me.upwind.io`\n\nFor instance, on the command line, use the `curl` command. Specify the HTTP method using the `--request` or `-X` flag, and provide the full URL using the `--url` flag.\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n:::note\nIf you get a message similar to \"command not found: curl\", you may need to download and install `curl`. For more information, see [the curl project download page](https://curl.se/download.html).\n:::\n\n### Using headers\n\nMost operations do not require specifying headers other than the `Authorization` header. Other operations may specify that you should pass an `Content-Type` header with a value of `application/json` or additional headers.\n\nTo send a header in a `curl` command, use the `--header` or `-H` flag followed by the header in `key: value` format.\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n### Using path parameters\n\nPath parameters modify the operation path. For example, the \"List threat detections\" path is `/v1/organizations/{organization-id}/threat-detections`. The curly brackets `{}` denote path parameters that you need to specify. In this case, you must specify your Upwind organization identifier. For the full reference documentation for this operation, see [List Threat Detections](/restapi/v1/list-threat-detections).\n\nFor example, to get a list of Threat Detection objects from the `org_Xk9mPq7RtYwN2vLs` organization, replace `{organization-id}` with `org_Xk9mPq7RtYwN2vLs` and prepend the base URL for the API. The full path is `https://api.upwind.io/v1/organizations/org_Xk9mPq7RtYwN2vLs/threat-detections`.\n\n### Using query parameters\n\nQuery parameters allow you to control what data is returned for a request. For example, a query parameter may let you specify how many items are returned when the response is paginated.\n\nFor `curl` commands, add a `?` to the end of the path, then append your query parameter name and value in the form `name=value`. Separate multiple query parameters with `&`.\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections?severity=CRITICAL\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n### Using body parameters\n\nBody parameters allow you to pass additional data to the API. For example, the \"Update a threat detection\" operation allows you to change the status of a detection. For the full reference documentation for this operation, see [Update a threat detection](/restapi/v1/update-threat-detection).\n\nFor `curl` commands, use the `--data` flag to pass the body parameters in a JSON object.\n\n```bash\ncurl --request PATCH \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections/{detection-id}\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\" \\\n --header \"Content-Type: application/json\" \\\n --data '{\n \"status\": \"ARCHIVED\"\n }'\n```\n\nThe operation updates the threat detection and returns data about the modified detection. For more information about using the response, see the [Using the response](#using-the-response) section.\n\n### Using the response\n\nEvery request will return an HTTP status code that indicates the success of the response. For more information about response codes, see [the MDN HTTP response status code documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status).\n\n### About the response code and headers\n\nTo view the status code and headers, use the `--include` or `--i` flag when you send your request.\n\nFor example, this request:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\" \\\n --include\n```\n\nReturns the response code and headers like:\n\n```bash\nHTTP/2 200\n```\n\nIn this example, the response code is `200`, which indicates a successful request.\n\n### About the response body\n\nMost operations will return a response body. Unless otherwise specified, the response body is in JSON format.\n\nFor example, this request returns a list of Threat Detection objects with data about each detection:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\nYou can also filter threat detections using query parameters. For example, to get all HIGH severity threat detections:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections?severity=HIGH\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n## Pagination\n\nMany list endpoints return large datasets that are divided into smaller, manageable chunks called pages. The API supports two types of pagination to help you navigate through these results efficiently.\n\nEach list endpoint supports one of the two pagination methods based on the potential amount of data that the endpoint can return. Information about which pagination method is used can be found on the specific endpoint's reference page.\n\n### Page-based Pagination\n\nPage-based pagination uses traditional page numbers to navigate through results. This method is useful when you need to jump to specific pages or when the total number of pages is known.\n\n#### Parameters\n- `page`: Specifies the page number for pagination (default: 1)\n- `per-page`: Specifies how many results are returned on a page (default: 100)\n\nFor example, to get the first page with 50 results per page:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections?page=1&per-page=50\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\nTo get the second page:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/threat-detections?page=2&per-page=50\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n### Token-based Pagination\n\nToken-based pagination uses opaque tokens to navigate through results. This method is more efficient for large datasets and ensures consistent results even when data is being modified during pagination.\n\n#### Parameters\n- `page-token`: Specifies the token for fetching subsequent pages in a paginated result set\n- `per-page`: Specifies how many results are returned on a page (default: 100)\n\n#### Response Headers\n- `Link`: Provides pagination links for navigating through the result set, formatted as HTTP link headers\n\nFor example, to get the first page:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/coniguration-findings?per-page=50\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\nTo get the next page, use the page-token from the previous response:\n\n```bash\ncurl --request GET \\\n --url \"https://api.upwind.io/v1/organizations/{organization-id}/coniguration-findings?page-token=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0&per-page=50\" \\\n --header \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n#### Working with Link Headers\n\nWhen using token-based pagination, the response includes a `Link` header with navigation URLs. This header follows the [RFC 5988](https://datatracker.ietf.org/doc/html/rfc5988) standard for web linking and provides ready-to-use URLs for pagination navigation.\n\n```bash\nLink: <https://api.upwind.io/v1/organizations/org_Xk9mPq7RtYwN2vLs/configuration-findings?page-token=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0&per-page=50>; rel=\"next\"\n```\n\nThe Link header may contain multiple relationships:\n- `rel=\"first\"`: URL for the first page of results\n- `rel=\"next\"`: URL for the next page of results (if available)\n- `rel=\"prev\"`: URL for the previous page of results (if available)\n- `rel=\"last\"`: URL for the last page of results (when determinable)\n\nMultiple links are comma-separated. For example:\n\n```bash\nLink: <https://api.upwind.io/v1/organizations/org_Xk9mPq7RtYwN2vLs/configuration-findings?page-token=abc123>; rel=\"first\", <https://api.upwind.io/v1/organizations/org_Xk9mPq7RtYwN2vLs/configuration-findings?page-token=xyz789>; rel=\"next\"\n```\n\nYou can parse this header to automatically navigate through pages without manually constructing URLs or managing page tokens. This approach is particularly useful for automated data processing workflows where you need to iterate through all available data.\n\n## Next steps\n\nThis article demonstrates how to make requests to the API. For more practice, try listing threat detections with different filters or retrieving a specific threat detection by ID. If you encounter any issues or have questions, refer to our [Support](/#contact-us-247-over-chat-email-or-slack) through various channels.\n\nHappy coding!\n"
title: Introduction access-management events API
version: '1.0'
servers:
- description: Production endpoint (US)
url: https://api.upwind.io
- description: Production endpoint (EU)
url: https://api.eu.upwind.io
- description: Production endpoint (ME)
url: https://api.me.upwind.io
tags:
- description: The Events resource offers a range of methods for listing, retrieving, and deleting events.
x-displayName: Events
name: events
paths:
/v1/organizations/{organization-id}/events:
post:
description: A `POST` request sent to the endpoint root creates an Event object that is associated with the specified organization. To learn more about Events, refer to the [Continuous Integration (CI)](/integrations/continuous-integration/overview) page.
x-order:
value: '1'
operationId: createEvent
parameters:
- $ref: '#/components/parameters/organization-id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/EventList'
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Rate Limit Exceeded
summary: Create an event
tags:
- events
/v1/organizations/{organization-id}/events/shift-left/search:
post:
description: A `POST` request sent to the endpoint searches for ShiftLeft Events between the start_time and end_time.
x-order:
value: '1'
operationId: searchShiftLeftEvents
parameters:
- $ref: '#/components/parameters/organization-id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShiftLeftListEventSearchRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ShiftLeftSearchEventsData'
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Rate Limit Exceeded
summary: Search ShiftLeft events
tags:
- events
/v2/organizations/{organization-id}/events/shift-left/search:
post:
description: A POST request sent to the search endpoint returns a filtered list of ShiftLeft events that are associated with the specified organization based on the specified search criteria.
x-order:
value: '1'
operationId: searchShiftLeftEvents
parameters:
- $ref: '#/components/parameters/organization-id'
- description: Specifies the maximum number of items to be returned.
in: query
name: limit
required: false
schema:
type: integer
format: int32
default: 50
maximum: 100
minimum: 1
- description: A cursor for pagination to retrieve the next set of results.
example: eyJvZmZzZXQiOjIwfQ
in: query
name: cursor
required: false
schema:
type: string
- description: 'Sort results by one or more fields. Format: `field` or `field:asc` or `field:desc`. Multiple fields: `field1,field2:desc`. Allowed fields: `update_time`, `create_time`. Default: `update_time:asc`.'
example: update_time:asc
in: query
name: sort
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
description: Search request body.
properties:
conditions:
type: array
description: List of filter conditions to apply to the search
items:
type: object
description: A filter condition for search queries
properties:
field:
type: string
description: The field name to filter on.
enum:
- architecture
- branch
- image
- update_time
- create_time
example: architecture
operator:
type: string
description: The comparison operator to apply.
enum:
- eq
- contains
- like
- in
- gte
- lte
example: eq
value:
type: array
description: The values to compare against.
example:
- linux/amd64
items: {}
required:
- operator
- value
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiPaginatedResponseApiShiftLeftEventData'
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Rate Limit Exceeded
summary: Search ShiftLeft events
tags:
- events
components:
schemas:
EventRequest:
type: object
properties:
data:
$ref: '#/components/schemas/EventData'
reporter:
type: string
enum:
- circle_ci
- CIRCLE_CI
- github_actions
- GITHUB_ACTIONS
- CUSTOM_CI
- custom_ci
- CUSTOM_CD
type:
type: string
enum:
- IMAGE_BUILD
- image_build
- IMAGE_DEPLOY
EventList:
type: object
properties:
data:
$ref: '#/components/schemas/EventData'
id:
type: string
description: ID of the event
reporter:
type: string
description: The entity creating the event.
enum:
- circle_ci
- CIRCLE_CI
- github_actions
- GITHUB_ACTIONS
- CUSTOM_CI
- custom_ci
- CUSTOM_CD
type:
type: string
description: The type of event.
enum:
- IMAGE_BUILD
- image_build
- IMAGE_DEPLOY
ShiftLeftEventData:
type: object
properties:
architecture:
type: string
branch:
type: string
commit_sha:
type: string
createdAt:
type: string
format: date-time
fingerprint:
type: string
image:
type: string
image_sha:
type: string
image_size:
type: integer
format: int64
initiator:
type: string
os:
type: string
repository:
type: string
repository_scan_details:
$ref: '#/components/schemas/ShiftLeftRepositoryEventData'
source:
type: string
type:
type: string
updatedAt:
type: string
format: date-time
variant:
type: string
CiEventData:
allOf:
- $ref: '#/components/schemas/EventData'
- type: object
properties:
branch:
type: string
description: The name of the branch involved in the event.
build_time:
type: string
format: date-time
description: Build time in date-time notation as defined by RFC 3339, section 5.6, for example, 2022-08-22T17:32:28Z
commit_sha:
type: string
description: The SHA of the commit involved in the event.
image:
type: string
description: The name of the image involved in the event.
image_sha:
type: string
description: The SHA of the image involved in the event.
pull_request_ids:
type: array
description: The identifiers of the Pull Requests involved in the event.
items:
type: integer
format: int32
repository:
type: string
description: The name of the repository involved in the event.
user:
type: string
version_control_platform:
type: string
description: The name of the version control platform.
ApiShiftLeftEventData:
type: object
properties:
architecture:
type: string
branch:
type: string
commit_sha:
type: string
create_time:
type: string
format: date-time
fingerprint:
type: string
image:
type: string
image_sha:
type: string
image_size_bytes:
type: integer
format: int64
initiator:
type: string
os:
type: string
repository:
type: string
repository_scan_details:
$ref: '#/components/schemas/ApiShiftLeftRepositoryEventData'
source:
type: string
type:
type: string
update_time:
type: string
format: date-time
variant:
type: string
ApiPaginationMetadata:
type: object
description: Pagination metadata for navigating through result pages
properties:
limit:
type: integer
format: int32
description: The maximum number of items returned per page
example: 20
next_cursor:
type: string
description: Cursor for fetching the next page of results. Absent if there are no more pages.
example: eyJvZmZzZXQiOjIwfQ
previous_cursor:
type: string
description: Cursor for fetching the previous page of results. Absent if this is the first page.
example: eyJvZmZzZXQiOjB9
ShiftLeftRepositoryEventData:
type: object
properties:
main_branch_name:
type: string
pr_id:
type: string
pr_link:
type: string
ShiftLeftSearchEventsData:
type: object
properties:
items:
type: array
description: ShiftLeft Events
items:
$ref: '#/components/schemas/ShiftLeftEventData'
metadata:
$ref: '#/components/schemas/ApiPaginationMetadata'
description: Pagination metadata
ShiftLeftListEventSearchRequest:
type: object
description: Request body for searching shift-left events
properties:
end_time:
type: integer
format: int64
description: End of the time range filter as Unix timestamp in milliseconds.
start_time:
type: integer
format: int64
description: Start of the time range filter as Unix timestamp in milliseconds.
CdEventData:
allOf:
- $ref: '#/components/schemas/EventData'
- type: object
properties:
cluster_id:
type: string
description: The unique identifier for the cluster associated with the resource involved in the event.
end_time:
type: string
format: date-time
description: End time in date-time notation as defined by RFC 3339, section 5.6, for example, 2022-08-22T17:32:28Z
initiator:
type: string
description: The initiator of the event.
resource_kind:
type: string
description: The kind of the resource involved in the event.
resource_name:
type: string
description: The name of the resource involved in the event.
resource_namespace:
type: string
description: The namespace of the resource involved in the event.
start_time:
type: string
format: date-time
description: Start time in date-time notation as defined by RFC 3339, section 5.6, for example, 2022-08-22T17:32:28Z
EventData:
oneOf:
- $ref: '#/components/schemas/CiEventData'
- $ref: '#/components/schemas/CdEventData'
ApiShiftLeftRepositoryEventData:
type: object
properties:
main_branch_name:
type: string
pr_id:
type: string
pr_link:
type: string
RestApiPaginatedResponseApiShiftLeftEventData:
type: object
description: Successful paginated API response containing items and pagination metadata
properties:
items:
type: array
description: The list of items in the response
items:
$ref: '#/components/schemas/ApiShiftLeftEventData'
metadata:
$ref: '#/components/schemas/ApiPaginationMetadata'
description: Pagination metadata containing cursor information for navigating results
parameters:
organization-id:
description: The unique identifier for the Upwind organization.
example: org_Xk9mPq7RtYwN2vLs
in: path
name: organization-id
required: true
schema:
type: string