Upwind Security api-security API

The API Security resource offers methods for retrieving API catalog endpoints and their security information.

OpenAPI Specification

upwind-security-api-security-api-openapi.yml Raw ↑
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 api-security 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 API Security resource offers methods for retrieving API catalog endpoints and their security information.
  x-displayName: API Security
  name: api-security
paths:
  /v1/organizations/{organization-id}/apisecurity-endpoints:
    get:
      description: A `GET` request sent to the endpoint root returns a list of API Endpoint objects that are associated with the specified organization. To learn more about API Security, refer to the [API Security Overview](/api-security/overview) page.
      x-order:
        value: '1'
      operationId: getApiCatalog
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - description: Specifies how many results are returned on a page.
        in: query
        name: per-page
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - description: Specifies the token for fetching subsequent pages in a paginated result set. Use the token from a previous response to continue retrieving data when the number of results exceeds the current page size.
        in: query
        name: page-token
        required: false
        schema:
          type: string
      - description: Filters endpoints by HTTP method (GET, POST, PUT, DELETE, etc.).
        in: query
        name: method
        required: false
        schema:
          type: string
      - description: Filters endpoints by authentication state. Multiple values may be provided, separated by commas.
        example: AUTHENTICATED,UNAUTHENTICATED
        in: query
        name: authentication-state
        required: false
        schema:
          type: string
          enum:
          - AUTHENTICATED
          - UNAUTHENTICATED
          - UNKNOWN
      - description: Filters endpoints that have internet ingress exposure.
        in: query
        name: has-internet-ingress
        required: false
        schema:
          type: boolean
      - description: Filters endpoints that have associated vulnerabilities.
        in: query
        name: has-vulnerability
        required: false
        schema:
          type: boolean
      - description: Filters endpoints that handle sensitive data.
        in: query
        name: has-sensitive-data
        required: false
        schema:
          type: boolean
      - description: Filters by the specified cloud account ID.
        in: query
        name: cloud-account-id
        required: false
        schema:
          type: string
      - description: Filters endpoints by cloud provider (AWS, Azure, GCP, etc.).
        in: query
        name: cloud-provider
        required: false
        schema:
          type: string
      - description: Filters endpoints by resource type.
        in: query
        name: resource-type
        required: false
        schema:
          type: string
      - description: Filters endpoints by cloud organization ID.
        in: query
        name: cloud-organization-id
        required: false
        schema:
          type: string
      - description: Filters endpoints by cloud organization unit ID.
        in: query
        name: cloud-organization-unit-id
        required: false
        schema:
          type: string
      - description: Filters endpoints by domain name.
        in: query
        name: domain
        required: false
        schema:
          type: string
      - description: Filters endpoints by cluster ID.
        in: query
        name: cluster-id
        required: false
        schema:
          type: string
      - description: Filters by the specified Kubernetes namespace.
        in: query
        name: namespace
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiEndpoint'
          description: OK
        '206':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiEndpoint'
          description: Partial Content
        '400':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiEndpoint'
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiEndpoint'
          description: Internal Server Error
      summary: List endpoints
      tags:
      - api-security
  /v2/organizations/{organization-id}/api-security/endpoints/search:
    post:
      description: A `POST` request sent to the search endpoint returns a list of API Endpoint objects matching the supplied search conditions.
      x-order:
        value: '1'
      operationId: searchEndpoints
      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: `first_seen_time`, `last_seen_time`.'
        example: first_seen_time:desc
        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:
                        - method
                        - authentication_state
                        - cloud_account_id
                        - cloud_provider
                        - resource_type
                        - cloud_organization_id
                        - cloud_organization_unit_id
                        - domain
                        - cluster_id
                        - namespace
                        - has_internet_ingress
                        - has_vulnerability
                        - has_sensitive_data
                        - first_seen_time
                        - last_seen_time
                        example: method
                      operator:
                        type: string
                        description: '`eq`/`in` are supported for enum and ID fields (`eq` matches a single value, `in` matches any of several); `eq` is supported for booleans; `gt`/`lt` are supported for timestamp fields (ISO8601 values only, e.g. `2024-01-01T00:00:00Z`).'
                        enum:
                        - eq
                        - in
                        - gt
                        - lt
                        example: eq
                      value:
                        type: array
                        description: The values to compare against.
                        example:
                        - GET
                        items: {}
                    required:
                    - operator
                    - value
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiPaginatedResponseApiEndpoint'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
      summary: Search API endpoints
      tags:
      - api-security
components:
  schemas:
    ApiEndpoint:
      type: object
      properties:
        domains:
          type: array
          description: List of domains associated with this endpoint.
          items:
            type: string
          uniqueItems: true
        first_seen_time:
          type: string
          format: date-time
          description: The timestamp when this endpoint was first observed.
        id:
          type: string
          description: The unique identifier for this endpoint.
        last_seen_time:
          type: string
          format: date-time
          description: The timestamp when this endpoint was last observed.
        method:
          type: string
          description: The HTTP method for this endpoint.
          enum:
          - GET
          - POST
          - PUT
          - DELETE
          - PATCH
          - HEAD
          - OPTIONS
          - TRACE
        resource_id:
          type: string
          description: The unique identifier of the associated resource.
        risk_overview:
          $ref: '#/components/schemas/ApiEndpointRiskOverview'
          description: Risk assessment overview for this endpoint.
        status_codes:
          type: array
          description: List of HTTP status codes observed for this endpoint.
          items:
            type: string
          uniqueItems: true
        uri:
          type: string
          description: The URI path for this endpoint.
    ApiAuthenticationDetails:
      type: object
      description: Authentication details for an endpoint.
      properties:
        state:
          type: string
          description: The endpoint's authentication state.
          enum:
          - authenticated
          - unauthenticated
          - unknown
    ApiEndpointInternetExposure:
      type: object
      properties:
        ingress:
          $ref: '#/components/schemas/ApiEndpointExposureDetails'
          description: Ingress exposure details for this endpoint.
    ApiEndpointRiskOverview:
      type: object
      properties:
        authentication:
          $ref: '#/components/schemas/ApiEndpointAuthentication'
          description: Authentication details for this endpoint.
        internet_exposure:
          $ref: '#/components/schemas/ApiEndpointInternetExposure'
          description: Internet exposure details for this endpoint.
        sensitive_data_findings:
          type: array
          description: List of sensitive data findings associated with this endpoint.
          items:
            $ref: '#/components/schemas/ApiEndpointSensitiveDataFinding'
    ApiEndpointAuthentication:
      type: object
      properties:
        state:
          type: string
          description: The authentication state of this endpoint.
          enum:
          - AUTHENTICATED
          - UNAUTHENTICATED
          - UNKNOWN
    RestApiPaginatedResponseApiEndpoint:
      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/ApiEndpoint_2'
        metadata:
          $ref: '#/components/schemas/ApiPaginationMetadata'
          description: Pagination metadata containing cursor information for navigating results
    ApiEndpointSensitiveDataFinding:
      type: object
      properties:
        category:
          type: string
          description: The category of sensitive data finding.
        last_seen_time:
          type: string
          format: date-time
          description: The timestamp when this sensitive data finding was last observed.
        type:
          type: string
          description: The type of sensitive data finding.
    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
    ApiExposureDetails:
      type: object
      description: Details about an observed exposure event.
      properties:
        last_seen_time:
          type: string
          format: date-time
          description: The exposure's last-seen timestamp (in ISO8601 format).
    ApiEndpoint_2:
      type: object
      description: An API endpoint discovered in the customer's environment.
      properties:
        domains:
          type: array
          description: List of domains associated with this endpoint.
          items:
            type: string
          uniqueItems: true
        first_seen_time:
          type: string
          format: date-time
          description: The endpoint's first-seen timestamp (in ISO8601 format).
        id:
          type: string
          description: The unique identifier of this endpoint.
        last_seen_time:
          type: string
          format: date-time
          description: The endpoint's last-seen timestamp (in ISO8601 format).
        method:
          type: string
          description: The HTTP method of this endpoint.
          enum:
          - GET
          - POST
          - PUT
          - DELETE
          - PATCH
          - HEAD
          - OPTIONS
          - TRACE
        resource_id:
          type: string
          description: The unique identifier of the resource that hosts this endpoint.
        risk_overview:
          $ref: '#/components/schemas/ApiRiskOverview'
          description: The risk assessment overview for this endpoint.
        status_codes:
          type: array
          description: List of HTTP status codes observed for this endpoint.
          items:
            type: string
          uniqueItems: true
        uri:
          type: string
          description: The URI path of this endpoint.
    ApiEndpointExposureDetails:
      type: object
      properties:
        last_seen_time:
          type: string
          format: date-time
          description: The timestamp when this exposure was last observed.
    ApiInternetExposure:
      type: object
      description: Internet exposure details for an endpoint.
      properties:
        ingress:
          $ref: '#/components/schemas/ApiExposureDetails'
          description: The endpoint's ingress exposure details.
    ApiSensitiveDataFinding:
      type: object
      description: A sensitive-data finding observed on an endpoint.
      properties:
        category:
          type: string
          description: The category of this sensitive-data finding.
        last_seen_time:
          type: string
          format: date-time
          description: The finding's last-seen timestamp (in ISO8601 format).
        type:
          type: string
          description: The type of this sensitive-data finding.
    ApiRiskOverview:
      type: object
      description: A summary of risk indicators for an endpoint.
      properties:
        authentication:
          $ref: '#/components/schemas/ApiAuthenticationDetails'
          description: The endpoint's authentication details, when known.
        internet_exposure:
          $ref: '#/components/schemas/ApiInternetExposure'
          description: The endpoint's internet exposure details. Present when the endpoint has been observed receiving internet traffic.
        sensitive_data:
          type: array
          description: List of sensitive-data findings observed for this endpoint.
          items:
            $ref: '#/components/schemas/ApiSensitiveDataFinding'
  parameters:
    organization-id:
      description: The unique identifier for the Upwind organization.
      example: org_Xk9mPq7RtYwN2vLs
      in: path
      name: organization-id
      required: true
      schema:
        type: string