find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aws-security-hub:aws-security-hub-connectors-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS SecurityHub Connectors API
  version: '2018-10-26'
  description: Generated from AWS's published Smithy model for AWS SecurityHub. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://securityhub.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Connectors
paths:
  /connectors:
    post:
      operationId: CreateConnector
      summary: Create Connector
      description: Creates a connector to a third-party cloud provider in Security Hub CSPM. A connector establishes a connection between Security Hub CSPM and a third-party cloud provider, enabling Security Hub CSPM to ingest security findings and resource data from the connected environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectorResponse'
              example:
                ConnectorArn: arn:aws:securityhub:us-east-1:123456789012:connector/cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                ConnectorId: cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                EnablementStatus: PENDING_ENABLEMENT
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectorRequest'
            example:
              Name: MyAzureConnector
              Description: Connector for Azure tenant monitoring
              Provider:
                Azure:
                  AWSConfigConnectorArn: arn:aws:config:us-east-1:123456789012:connector/azure-connector-1234
                  ScopeConfiguration:
                    ScopeType: TENANT
                  AzureRegions:
                  - eastus
                  - westus2
      tags:
      - Connectors
    get:
      operationId: ListConnectors
      summary: List Connectors
      description: Lists the CSPM connectors and their metadata for the calling account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorsResponse'
              example:
                Connectors:
                - ConnectorArn: arn:aws:securityhub:us-east-1:123456789012:connector/cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                  ConnectorId: cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                  Name: MyAzureConnector
                  ProviderSummary:
                    ProviderName: AZURE
                    ConnectorStatus: CONNECTED
                  CreatedAt: '2026-01-15T10:30:00.000Z'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConnectorsRequest'
            example:
              MaxResults: 10
      tags:
      - Connectors
  /connectors/{ConnectorId+}:
    delete:
      operationId: DeleteConnector
      summary: Delete Connector
      description: Deletes a CSPM connector. When you delete a connector, Security Hub CSPM stops ingesting findings and resource data from the connected cloud provider environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteConnectorResponse'
              example:
                EnablementStatus: PENDING_DELETION
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConnectorRequest'
            example:
              ConnectorId: cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
      tags:
      - Connectors
    get:
      operationId: GetConnector
      summary: Get Connector
      description: Retrieves details for a CSPM connector based on the connector ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectorResponse'
              example:
                ConnectorArn: arn:aws:securityhub:us-east-1:123456789012:connector/cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                ConnectorId: cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                Name: MyAzureConnector
                Description: Connector for Azure tenant monitoring
                CreatedAt: '2026-01-15T10:30:00.000Z'
                LastUpdatedAt: '2026-05-20T14:00:00.000Z'
                Health:
                  ConnectorStatus: CONNECTED
                  LastCheckedAt: '2026-05-20T14:00:00.000Z'
                ProviderDetail:
                  Azure:
                    AWSConfigConnectorArn: arn:aws:config:us-east-1:123456789012:connector/azure-connector-1234
                    ScopeConfiguration:
                      ScopeType: TENANT
                    AzureRegions:
                    - eastus
                    - westus2
                CreatedBy: securityhub.amazonaws.com
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConnectorRequest'
            example:
              ConnectorId: cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
      tags:
      - Connectors
    patch:
      operationId: UpdateConnector
      summary: Update Connector
      description: Updates a CSPM connector's configuration, such as the scope or regions for the connected cloud provider.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConnectorResponse'
              example:
                ConnectorStatus: CONNECTED
                EnablementStatus: PENDING_UPDATE
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectorRequest'
            example:
              ConnectorId: cspm-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
              Description: Updated connector description
              Provider:
                Azure:
                  ScopeConfiguration:
                    ScopeType: SUBSCRIPTION
                    ScopeValues:
                    - sub-1234-5678-abcd
                    - sub-9012-3456-efgh
                  AzureRegions:
                  - eastus
                  - westus2
                  - northeurope
      tags:
      - Connectors
components:
  schemas:
    DeleteConnectorResponse:
      type: object
      properties:
        EnablementStatus:
          type: string
          enum:
          - ENABLED
          - PENDING_ENABLEMENT
          - PENDING_UPDATE
          - PENDING_DELETION
          description: The enablement status of the connector after the delete request.
    CspmConnectorSummary:
      type: object
      properties:
        ConnectorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the connector.
        ConnectorId:
          type: string
          description: The unique identifier of the connector.
        Name:
          type: string
          description: The name of the connector.
        Description:
          type: string
          description: The description of the connector.
        ProviderSummary:
          $ref: '#/components/schemas/CspmProviderSummary'
        CreatedAt:
          type: string
          format: date-time
          description: The ISO 8601 UTC timestamp indicating when the connector was created.
        CreatedBy:
          type: string
          description: The service principal that created the connector.
        EnablementStatus:
          type: string
          enum:
          - ENABLED
          - PENDING_ENABLEMENT
          - PENDING_UPDATE
          - PENDING_DELETION
          description: The enablement status of the connector.
    CspmProviderConfiguration:
      type: object
      properties:
        Azure:
          $ref: '#/components/schemas/AzureProviderConfiguration'
      description: Exactly one member is set.
    AzureProviderConfiguration:
      type: object
      properties:
        AWSConfigConnectorArn:
          type: string
          description: The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
        ScopeConfiguration:
          $ref: '#/components/schemas/AzureScopeConfiguration'
        AzureRegions:
          type: array
          items:
            type: string
          description: The list of Azure regions to monitor.
      required:
      - AWSConfigConnectorArn
      - ScopeConfiguration
      - AzureRegions
    UpdateConnectorRequest:
      type: object
      properties:
        ConnectorId:
          type: string
          description: The unique identifier of the connector to update.
        Description:
          type: string
          description: The updated description of the connector.
        Provider:
          $ref: '#/components/schemas/CspmProviderUpdateConfiguration'
      required:
      - ConnectorId
    HealthIssue:
      type: object
      properties:
        Code:
          type: string
          enum:
          - AUTHENTICATION_FAILURE
          - STREAM_AUTHORIZATION_FAILURE
          - DISCOVERY_FAILURE
          - STREAM_LIMIT_EXCEEDED
          - STREAM_DISCONNECTED
          - RECORDING_FAILURE
          - NO_HEALTH_DATA
          description: The error code that identifies the type of health issue.
        Message:
          type: string
          description: A human-readable message that describes the health issue.
      required:
      - Code
      - Message
    UpdateConnectorResponse:
      type: object
      properties:
        ConnectorStatus:
          type: string
          enum:
          - CONNECTED
          - DEGRADED
          - FAILED_TO_CONNECT
          - UNKNOWN
          description: The connectivity status of the connector after the update.
        EnablementStatus:
          type: string
          enum:
          - ENABLED
          - PENDING_ENABLEMENT
          - PENDING_UPDATE
          - PENDING_DELETION
          description: The enablement status of the connector after the update.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    InvalidAccessException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    CspmProviderSummary:
      type: object
      properties:
        ProviderName:
          type: string
          enum:
          - AZURE
          description: The name of the cloud provider.
        ConnectorStatus:
          type: string
          enum:
          - CONNECTED
          - DEGRADED
          - FAILED_TO_CONNECT
          - UNKNOWN
          description: The connectivity status of the connector.
        ProviderConfiguration:
          $ref: '#/components/schemas/CspmProviderDetail'
    CspmProviderUpdateConfiguration:
      type: object
      properties:
        Azure:
          $ref: '#/components/schemas/AzureUpdateConfiguration'
      description: Exactly one member is set.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    AzureUpdateConfiguration:
      type: object
      properties:
        ScopeConfiguration:
          $ref: '#/components/schemas/AzureScopeConfiguration'
        AzureRegions:
          type: array
          items:
            type: string
          description: The updated list of Azure regions to monitor.
      required:
      - ScopeConfiguration
      - AzureRegions
    CspmProviderDetail:
      type: object
      properties:
        Azure:
          $ref: '#/components/schemas/AzureDetail'
      description: Exactly one member is set.
    AzureDetail:
      type: object
      properties:
        AWSConfigConnectorArn:
          type: string
          description: The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
        ScopeConfiguration:
          $ref: '#/components/schemas/AzureScopeConfiguration'
        AzureRegions:
          type: array
          items:
            type: string
          description: The list of Azure regions being monitored.
      required:
      - AWSConfigConnectorArn
      - ScopeConfiguration
      - AzureRegions
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    GetConnectorResponse:
      type: object
      properties:
        ConnectorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the connector.
        ConnectorId:
          type: string
          description: The unique identifier of the connector.
        Name:
          type: string
          description: The name of the connector.
        Description:
          type: string
          description: The description of the connector.
        CreatedAt:
          type: string
          format: date-time
          description: The ISO 8601 UTC timestamp indicating when the connector was created.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The ISO 8601 UTC timestamp indicating when the connector was last updated.
        Health:
          $ref: '#/components/schemas/CspmHealthCheck'
        ProviderDetail:
          $ref: '#/components/schemas/CspmProviderDetail'
        CreatedBy:
          type: string
          description: The service principal that created the connector.
        EnablementStatus:
          type: string
          enum:
          - ENABLED
          - PENDING_ENABLEMENT
          - PENDING_UPDATE
          - PENDING_DELETION
          description: The enablement status of the connector.
      required:
      - ConnectorId
      - Name
      - CreatedAt
      - LastUpdatedAt
      - Health
      - ProviderDetail
    ListConnectorsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token to request the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
        ProviderName:
          type: string
          enum:
          - AZURE
          description: The name of the cloud provider to filter connectors by.
        ConnectorStatus:
          type: string
          enum:
          - CONNECTED
          - DEGRADED
          - FAILED_TO_CONNECT
          - UNKNOWN
          description: The connectivity status to filter connectors by.
        EnablementStatus:
          type: string
          enum:
          - ENABLED
          - PENDING_ENABLEMENT
          - PENDING_UPDATE
          - PENDING_DELETION
          description: The enablement status to filter connectors by.
    CreateConnectorRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the connector. Must be unique within the account.
        Description:
          type: string
          description: The description of the connector.
        Provider:
          $ref: '#/components/schemas/CspmProviderConfiguration'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to add to the connector resource.
        ClientToken:
          type: string
          description: A unique identifier used to ensure idempotency of the request.
      required:
      - Name
      - Provider
    CspmHealthCheck:
      type: object
      properties:
        ConnectorStatus:
          type: string
          enum:
          - CONNECTED
          - DEGRADED
          - FAILED_TO_CONNECT
          - UNKNOWN
          description: The connectivity status of the connector.
        Message:
          type: string
          description: A message describing the reason for the current connector status.
        LastCheckedAt:
          type: string
          format: date-time
          description: The ISO 8601 UTC timestamp indicating when the health status was last checked.
        Issues:
          type: array
          items:
            $ref: '#/components/schemas/HealthIssue'
          description: A list of health issues associated with the connector.
      required:
      - ConnectorStatus
      - LastCheckedAt
    CreateConnectorResponse:
      type: object
      properties:
        ConnectorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the connector.
        ConnectorId:
          type: string
          description: The unique identifier of the connector.
        ConnectorStatus:
          type: string
          enum:
          - CONNECTED
          - DEGRADED
          - FAILED_TO_CONNECT
          - UNKNOWN
          description: The connectivity status of the connector.
        EnablementStatus:
          type: string
          enum:
          - ENABLED
          - PENDING_ENABLEMENT
          - PENDING_UPDATE
          - PENDING_DELETION
          description: The enablement status of the connector.
      required:
      - ConnectorArn
      - ConnectorId
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    AzureScopeConfiguration:
      type: object
      properties:
        ScopeType:
          type: string
          enum:
          - TENANT
          - SUBSCRIPTION
          description: The type of scope. Valid values are tenant and subscription.
        ScopeValues:
          type: array
          items:
            type: string
          description: The list of scope values, such as subscription IDs, when the scope type is subscription.
      required:
      - ScopeType
    ListConnectorsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token to use to request the next page of results. If there are no additional results, this value is null.
        Connectors:
          type: array
          items:
            $ref: '#/components/schemas/CspmConnectorSummary'
          description: An array of connector summaries.
      required:
      - Connectors
    GetConnectorRequest:
      type: object
      properties:
        ConnectorId:
          type: string
          description: The unique identifier of the connector to retrieve.
      required:
      - ConnectorId
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    DeleteConnectorRequest:
      type: object
      properties:
        ConnectorId:
          type: string
          description: The unique identifier of the connector to delete.
      required:
      - ConnectorId
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: securityhub
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/securityhub/service/2018-10-26/securityhub-2018-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)