Upwind Security packages API

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 packages 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 Packages resource offers methods for retrieving Software Bill of Materials (SBOM) package details.
  x-displayName: Packages
  name: packages
paths:
  /v1/organizations/{organization-id}/sbom-packages:
    get:
      description: A `GET` request sent to the endpoint root returns a list of Software Bill of Materials (SBOM) packages associated with the specified organization. This endpoint provides comprehensive details about packages including their vulnerabilities, affected resources, and usage statistics. The results can be filtered by various criteria including package name, version, framework, and more.
      x-order:
        value: '1'
      operationId: listSbomPackages
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - description: Filters by the specified cloud account ID.
        in: query
        name: cloud-account-id
        required: false
        schema:
          type: string
      - description: Filters packages by the specified framework.
        in: query
        name: framework
        required: false
        schema:
          type: string
      - description: Filters packages by the specified image name.
        in: query
        name: image-name
        required: false
        schema:
          type: string
      - description: Filters packages by the specified package name.
        in: query
        name: package-name
        required: false
        schema:
          type: string
      - description: Filters packages by the specified package manager.
        in: query
        name: package-manager
        required: false
        schema:
          type: string
      - description: Filters packages by the specified package license.
        in: query
        name: package-license
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SbomPackage'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
      summary: List SBOM packages
      tags:
      - packages
  /v1/organizations/{organization-id}/sbom-packages/{package-path}:
    get:
      description: A `GET` request sent to the endpoint root followed by package name and version returns detailed information about a specific SBOM package. This endpoint provides comprehensive details about the package including vulnerabilities, affected resources, images, and usage statistics.
      x-order:
        value: '2'
      operationId: getSbomPackageDetails
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - description: The path containing the package name followed by its version (e.g. `lodash/4.17.21`).
        in: path
        name: package-path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SbomPackageDetails'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Rate Limit Exceeded
      summary: Get SBOM package details
      tags:
      - packages
components:
  schemas:
    SbomPackageDetails:
      type: object
      properties:
        cloud_account_id:
          type: string
          description: The unique identifier for the cloud account associated with this package.
        cloud_provider:
          type: string
          description: The cloud provider associated with this package.
          enum:
          - AWS
          - AZURE
          - GCP
          - ORACLE
          - BYOC
        framework:
          type: string
          description: The framework associated with this package.
        images:
          type: array
          description: List of images containing this package.
          items:
            $ref: '#/components/schemas/PackageDetailsImage'
        images_summary:
          $ref: '#/components/schemas/ImagesSummary'
          description: Summary of images associated with this package.
        licenses:
          type: array
          description: The licenses associated with this package.
          items:
            type: string
          uniqueItems: true
        name:
          type: string
          description: The name of the package.
        package_manager:
          type: string
          description: The package manager associated with this package.
        resources:
          type: array
          description: List of resources using this package.
          items:
            $ref: '#/components/schemas/PackageDetailsResource'
        resources_summary:
          $ref: '#/components/schemas/ResourcesSummary'
          description: Summary of resources associated with this package.
        version:
          type: string
          description: The version of the package.
        vulnerabilities:
          type: array
          description: Detailed list of vulnerabilities found in this package.
          items:
            $ref: '#/components/schemas/PackageDetailsVulnerability'
        vulnerabilities_summary:
          $ref: '#/components/schemas/VulnerabilitiesSummary'
          description: Summary of vulnerabilities found in this package.
    PackageDetailsImage:
      type: object
      properties:
        digest:
          type: string
          description: The digest of this image.
        name:
          type: string
          description: The name of this image.
        registry:
          type: string
          description: The registry where this image is stored.
        resource_id:
          type: string
          description: The unique identifier for the resource associated with this image.
        scan_source:
          type: string
          description: The source of the image scan.
        uri:
          type: string
          description: The URI of this image.
        version:
          type: string
          description: The version of this image.
    SbomPackage:
      type: object
      properties:
        cloud_account_id:
          type: string
          description: The unique identifier for the cloud account associated with this package.
        cloud_provider:
          type: string
          description: The cloud provider associated with this package.
          enum:
          - AWS
          - AZURE
          - GCP
          - ORACLE
          - BYOC
        framework:
          type: string
          description: The framework associated with this package.
        images_summary:
          $ref: '#/components/schemas/ImagesSummary'
          description: Summary of images associated with this package.
        licenses:
          type: array
          description: The licenses associated with this package.
          items:
            type: string
          uniqueItems: true
        name:
          type: string
          description: The name of the package.
        package_manager:
          type: string
          description: The package manager associated with this package.
        resources_summary:
          $ref: '#/components/schemas/ResourcesSummary'
          description: Summary of resources associated with this package.
        version:
          type: string
          description: The version of the package.
        vulnerabilities_summary:
          $ref: '#/components/schemas/VulnerabilitiesSummary'
          description: Summary of vulnerabilities found in this package.
    VulnerabilitiesSummary:
      type: object
      properties:
        critical_count:
          type: integer
          format: int32
          description: The number of critical vulnerabilities.
        high_count:
          type: integer
          format: int32
          description: The number of high severity vulnerabilities.
        low_count:
          type: integer
          format: int32
          description: The number of low severity vulnerabilities.
        medium_count:
          type: integer
          format: int32
          description: The number of medium severity vulnerabilities.
        total_count:
          type: integer
          format: int32
        unclassified_count:
          type: integer
          format: int32
    ResourcesSummary:
      type: object
      properties:
        in_use_count:
          type: integer
          format: int32
          description: The number of resources currently using this package.
        total_count:
          type: integer
          format: int32
          description: The total number of resources associated with this package.
    PackageDetailsVulnerability:
      type: object
      properties:
        cve_first_seen_time:
          type: string
          format: date-time
          description: The timestamp when this CVE was first seen.
        cve_id:
          type: string
          description: The Common Vulnerabilities and Exposures (CVE) unique identifier for this vulnerability.
        cvss_v2_score:
          type: string
          description: The CVSS v2 score for this vulnerability.
        cvss_v2_severity:
          type: string
          description: The CVSS v2 severity level for this vulnerability.
        cvss_v3_score:
          type: string
          description: The CVSS v3 score for this vulnerability.
        cvss_v3_severity:
          type: string
          description: The CVSS v3 severity level for this vulnerability.
        cvss_v4_score:
          type: string
          description: The CVSS v4 score for this vulnerability.
        cvss_v4_severity:
          type: string
          description: The CVSS v4 severity level for this vulnerability.
        description:
          type: string
          description: The description of this vulnerability.
        fixed_in_version:
          type: string
          description: The version where this vulnerability is fixed.
        id:
          type: integer
          format: int32
          description: The unique identifier for this vulnerability.
        last_modification_time:
          type: string
          format: date-time
          description: The timestamp when this vulnerability was last modified.
        nist_severity:
          type: string
          description: The NIST severity level for this vulnerability.
        publish_time:
          type: string
          format: date-time
          description: The timestamp when this vulnerability was published.
        update_time:
          type: string
          format: date-time
          description: The timestamp when this vulnerability information was last updated.
    BlEndpointRiskOverview:
      type: object
      properties:
        critical_detections_count:
          type: integer
          format: int32
        critical_vulnerabilities_count:
          type: integer
          format: int32
        has_active_internet_egress:
          type: boolean
        has_active_internet_ingress:
          type: boolean
        sensitive_data_categories:
          type: array
          items:
            type: string
          uniqueItems: true
        sensitive_data_tags:
          type: array
          items:
            type: string
    ImagesSummary:
      type: object
      properties:
        affected_count:
          type: integer
          format: int32
          description: The number of images affected by this package.
    PackageDetailsResource:
      type: object
      properties:
        cloud_account_id:
          type: string
          description: The unique identifier for the cloud account associated with this resource.
        cloud_provider:
          type: string
          description: The cloud provider of this resource.
          enum:
          - AWS
          - AZURE
          - GCP
          - ORACLE
          - BYOC
        cluster_id:
          type: string
          description: The unique identifier for the cluster associated with this resource.
        cluster_name:
          type: string
          description: The name of the cluster associated with this resource.
        id:
          type: string
          description: The unique identifier for this resource.
        image_asset_ids:
          type: array
          description: List of image asset IDs associated with this resource.
          items:
            type: string
        name:
          type: string
          description: The name of this resource.
        namespace:
          type: string
          description: The namespace of this resource.
        region:
          type: string
          description: The region where this resource is located.
        risk_overview:
          $ref: '#/components/schemas/BlEndpointRiskOverview'
          description: Risk overview for this resource.
        status:
          type: string
          description: The status of this resource.
          enum:
          - ACTIVE
          - INACTIVE
          - UNKNOWN
        type:
          type: string
          description: The type of this resource.
          enum:
          - AwsAutoScalingGroup
          - AwsInstance
          - AwsLambdaFunction
          - AzureVirtualMachineScaleSet
          - AzureVirtualMachine
          - AzureFunctionApp
          - GcpInstanceGroup
          - GcpInstance
          - CloudRunServiceContainer
          - CloudRunServiceFunction
          - CloudRunJob
          - Deployment
          - StatefulSet
          - DaemonSet
          - CronJob
          - ReplicaSet
          - StandAlone
          - K8SCluster
          - GpcGke
          - AwsEks
          - AzureAks
          - K8SNode
          - ECSService
          - ECSStandaloneTask
          - ECSWorkload
          - ByocHost
          - Host
          - HostContainer
          - Unknown
        upwind_asset_id:
          type: string
          description: The Upwind asset identifier for this resource.
        vulnerabilities_summary:
          $ref: '#/components/schemas/VulnerabilitiesSummary'
          description: Summary of vulnerabilities found in this resource.
  parameters:
    organization-id:
      description: The unique identifier for the Upwind organization.
      example: org_Xk9mPq7RtYwN2vLs
      in: path
      name: organization-id
      required: true
      schema:
        type: string