AWS Security Hub Security Hub Connectorsv2 API
The Security Hub Connectorsv2 API from AWS Security Hub — 3 operation(s) for security hub connectorsv2.
The Security Hub Connectorsv2 API from AWS Security Hub — 3 operation(s) for security hub connectorsv2.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/aws-security-hub:aws-security-hub-connectorsv2-api"
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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: AWS SecurityHub Connectorsv2 API
version: '2018-10-26'
description: Generated from AWS's published Smithy model for AWS SecurityHub. 6 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: Connectorsv2
paths:
/connectorsv2:
post:
operationId: CreateConnectorV2
summary: Create Connector V2
description: Grants permission to create a connectorV2 based on input parameters.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConnectorV2Response'
'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'
'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/CreateConnectorV2Request'
tags:
- Connectorsv2
get:
operationId: ListConnectorsV2
summary: List Connectors V2
description: Grants permission to retrieve a list of connectorsV2 and their metadata for the calling account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListConnectorsV2Response'
'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'
'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/ListConnectorsV2Request'
tags:
- Connectorsv2
/connectorsv2/{ConnectorId+}:
delete:
operationId: DeleteConnectorV2
summary: Delete Connector V2
description: Grants permission to delete a connectorV2.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConnectorV2Response'
'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'
'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/DeleteConnectorV2Request'
tags:
- Connectorsv2
get:
operationId: GetConnectorV2
summary: Get Connector V2
description: Grants permission to retrieve details for a connectorV2 based on connector id.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetConnectorV2Response'
'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'
'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/GetConnectorV2Request'
tags:
- Connectorsv2
patch:
operationId: UpdateConnectorV2
summary: Update Connector V2
description: Grants permission to update a connectorV2 based on its id and input parameters.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConnectorV2Response'
'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'
'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/UpdateConnectorV2Request'
tags:
- Connectorsv2
/connectorsv2/register:
post:
operationId: RegisterConnectorV2
summary: Register Connector V2
description: Grants permission to complete the authorization based on input parameters.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterConnectorV2Response'
'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'
'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/RegisterConnectorV2Request'
tags:
- Connectorsv2
components:
schemas:
UpdateConnectorV2Request:
type: object
properties:
ConnectorId:
type: string
description: The UUID of the connectorV2 to identify connectorV2 resource.
Description:
type: string
description: The description of the connectorV2.
Provider:
$ref: '#/components/schemas/ProviderUpdateConfiguration'
required:
- ConnectorId
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
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
HealthCheck:
type: object
properties:
ConnectorStatus:
type: string
enum:
- CONNECTED
- DEGRADED
- FAILED_TO_CONNECT
- PENDING_AUTHORIZATION
- PENDING_CONFIGURATION
- UNKNOWN
description: The status of the connectorV2.
Message:
type: string
description: The message for the reason of connectorStatus change.
LastCheckedAt:
type: string
format: date-time
description: ISO 8601 UTC timestamp for the time check the health status of the connectorV2.
Issues:
type: array
items:
$ref: '#/components/schemas/HealthIssue'
description: A list of health issues associated with the connector, including error codes and messages.
required:
- ConnectorStatus
- LastCheckedAt
ThrottlingException:
type: object
properties:
Message:
type: string
Code:
type: string
ProviderConfiguration:
type: object
properties:
JiraCloud:
$ref: '#/components/schemas/JiraCloudProviderConfiguration'
ServiceNow:
$ref: '#/components/schemas/ServiceNowProviderConfiguration'
Azure:
$ref: '#/components/schemas/AzureProviderConfiguration'
description: Exactly one member is set.
RegisterConnectorV2Response:
type: object
properties:
ConnectorArn:
type: string
description: The Amazon Resource Name (ARN) of the connectorV2.
ConnectorId:
type: string
description: The UUID of the connectorV2 to identify connectorV2 resource.
required:
- ConnectorId
ListConnectorsV2Request:
type: object
properties:
NextToken:
type: string
description: The pagination token per the Amazon Web Services Pagination standard
MaxResults:
type: integer
description: The maximum number of results to be returned.
ProviderName:
type: string
enum:
- JIRA_CLOUD
- SERVICENOW
- AZURE
description: The name of the third-party provider.
ConnectorStatus:
type: string
enum:
- CONNECTED
- DEGRADED
- FAILED_TO_CONNECT
- PENDING_AUTHORIZATION
- PENDING_CONFIGURATION
- UNKNOWN
description: The status for the connectorV2.
EnablementStatus:
type: string
enum:
- ENABLED
- PENDING_ENABLEMENT
- FAILED_TO_ENABLE
- PENDING_UPDATE
- FAILED_TO_UPDATE
- PENDING_DELETION
- FAILED_TO_DELETE
description: The enablement status to filter connectors by.
ValidationException:
type: object
properties:
Message:
type: string
Code:
type: string
ServiceNowDetail:
type: object
properties:
InstanceName:
type: string
description: The instanceName of ServiceNow ITSM.
SecretArn:
type: string
description: The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
AuthStatus:
type: string
enum:
- ACTIVE
- FAILED
description: The status of the authorization between ServiceNow and the service.
required:
- SecretArn
- AuthStatus
ConnectorSummary:
type: object
properties:
ConnectorArn:
type: string
description: The Amazon Resource Name (ARN) of the connectorV2.
ConnectorId:
type: string
description: The UUID of the connectorV2 to identify connectorV2 resource.
Name:
type: string
description: The Name field contains the user-defined name assigned to the integration connector. This helps identify and manage multiple connectors within Security Hub.
Description:
type: string
description: The description of the connectorV2.
ProviderSummary:
$ref: '#/components/schemas/ProviderSummary'
CreatedAt:
type: string
format: date-time
description: ISO 8601 UTC timestamp for the time create the connectorV2.
EnablementStatus:
type: string
enum:
- ENABLED
- PENDING_ENABLEMENT
- FAILED_TO_ENABLE
- PENDING_UPDATE
- FAILED_TO_UPDATE
- PENDING_DELETION
- FAILED_TO_DELETE
description: The enablement status of the connector.
EnablementStatusReason:
type: string
description: The reason for the current enablement status. Provides additional context when the connector is in a failed state.
required:
- ConnectorId
- Name
- ProviderSummary
- CreatedAt
ServiceNowProviderConfiguration:
type: object
properties:
InstanceName:
type: string
description: The instance name of ServiceNow ITSM.
SecretArn:
type: string
description: The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
required:
- InstanceName
- SecretArn
ProviderDetail:
type: object
properties:
JiraCloud:
$ref: '#/components/schemas/JiraCloudDetail'
ServiceNow:
$ref: '#/components/schemas/ServiceNowDetail'
Azure:
$ref: '#/components/schemas/AzureDetail'
description: Exactly one member is set.
InternalServerException:
type: object
properties:
Message:
type: string
Code:
type: string
RegisterConnectorV2Request:
type: object
properties:
AuthCode:
type: string
description: The authCode retrieved from authUrl to complete the OAuth 2.0 authorization code flow.
AuthState:
type: string
description: The authState retrieved from authUrl to complete the OAuth 2.0 authorization code flow.
required:
- AuthCode
- AuthState
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
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
UpdateConnectorV2Response:
type: object
properties:
ConnectorStatus:
type: string
enum:
- CONNECTED
- DEGRADED
- FAILED_TO_CONNECT
- PENDING_AUTHORIZATION
- PENDING_CONFIGURATION
- UNKNOWN
description: The status of the connector after the update.
EnablementStatus:
type: string
enum:
- ENABLED
- PENDING_ENABLEMENT
- FAILED_TO_ENABLE
- PENDING_UPDATE
- FAILED_TO_UPDATE
- PENDING_DELETION
- FAILED_TO_DELETE
description: The enablement status of the connector after the update.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
Code:
type: string
GetConnectorV2Response:
type: object
properties:
ConnectorArn:
type: string
description: The Amazon Resource Name (ARN) of the connectorV2.
ConnectorId:
type: string
description: The UUID of the connectorV2 to identify connectorV2 resource.
Name:
type: string
description: The name of the connectorV2.
Description:
type: string
description: The description of the connectorV2.
KmsKeyArn:
type: string
description: The Amazon Resource Name (ARN) of KMS key used for the connectorV2.
CreatedAt:
type: string
format: date-time
description: ISO 8601 UTC timestamp for the time create the connectorV2.
LastUpdatedAt:
type: string
format: date-time
description: ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.
Health:
$ref: '#/components/schemas/HealthCheck'
ProviderDetail:
$ref: '#/components/schemas/ProviderDetail'
EnablementStatus:
type: string
enum:
- ENABLED
- PENDING_ENABLEMENT
- FAILED_TO_ENABLE
- PENDING_UPDATE
- FAILED_TO_UPDATE
- PENDING_DELETION
- FAILED_TO_DELETE
description: The enablement status of the connector.
EnablementStatusReason:
type: string
description: The reason for the current enablement status. Provides additional context when the connector is in a failed state.
required:
- ConnectorId
- Name
- CreatedAt
- LastUpdatedAt
- Health
- ProviderDetail
ProviderSummary:
type: object
properties:
ProviderName:
type: string
enum:
- JIRA_CLOUD
- SERVICENOW
- AZURE
description: The name of the provider.
ConnectorStatus:
type: string
enum:
- CONNECTED
- DEGRADED
- FAILED_TO_CONNECT
- PENDING_AUTHORIZATION
- PENDING_CONFIGURATION
- UNKNOWN
description: The status for the connectorV2.
ProviderConfiguration:
$ref: '#/components/schemas/ProviderDetail'
JiraCloudDetail:
type: object
properties:
CloudId:
type: string
description: The cloud id of the Jira Cloud.
ProjectKey:
type: string
description: The projectKey of Jira Cloud.
Domain:
type: string
description: The URL domain of your Jira Cloud instance.
AuthUrl:
type: string
description: The URL to provide to customers for OAuth auth code flow.
AuthStatus:
type: string
enum:
- ACTIVE
- FAILED
description: The status of the authorization between Jira Cloud and the service.
CreateConnectorV2Response:
type: object
properties:
ConnectorArn:
type: string
description: The Amazon Resource Name (ARN) of the connectorV2.
ConnectorId:
type: string
description: The UUID of the connectorV2 to identify connectorV2 resource.
AuthUrl:
type: string
description: The Url provide to customers for OAuth auth code flow.
ConnectorStatus:
type: string
enum:
- CONNECTED
- DEGRADED
- FAILED_TO_CONNECT
- PENDING_AUTHORIZATION
- PENDING_CONFIGURATION
- UNKNOWN
description: The current status of the connectorV2.
EnablementStatus:
type: string
enum:
- ENABLED
- PENDING_ENABLEMENT
- FAILED_TO_ENABLE
- PENDING_UPDATE
- FAILED_TO_UPDATE
- PENDING_DELETION
- FAILED_TO_DELETE
description: The enablement status of the connector after creation.
required:
- ConnectorArn
- ConnectorId
GetConnectorV2Request:
type: object
properties:
ConnectorId:
type: string
description: The UUID of the connectorV2 to identify connectorV2 resource.
required:
- ConnectorId
CreateConnectorV2Request:
type: object
properties:
Name:
type: string
description: The unique name of the connectorV2.
Description:
type: string
description: The description of the connectorV2.
Provider:
$ref: '#/components/schemas/ProviderConfiguration'
KmsKeyArn:
type: string
description: The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.
Tags:
type: object
additionalProperties:
type: string
description: The tags to add to the connectorV2 when you create.
ClientToken:
type: string
description: A unique identifier used to ensure idempotency.
required:
- Name
- Provider
ListConnectorsV2Response:
type: object
properties:
NextToken:
type: string
description: The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Connectors:
type: array
items:
$ref: '#/components/schemas/ConnectorSummary'
description: An array of connectorV2 summaries.
required:
- Connectors
DeleteConnectorV2Response:
type: object
properties:
EnablementStatus:
type: string
enum:
- ENABLED
- PENDING_ENABLEMENT
- FAILED_TO_ENABLE
- PENDING_UPDATE
- FAILED_TO_UPDATE
- PENDING_DELETION
- FAILED_TO_DELETE
description: The enablement status of the connector after deletion.
ProviderUpdateConfiguration:
type: object
properties:
JiraCloud:
$ref: '#/components/schemas/JiraCloudUpdateConfiguration'
ServiceNow:
$ref: '#/components/schemas/ServiceNowUpdateConfiguration'
Azure:
$ref: '#/components/schemas/AzureUpdateConfiguration'
description: Exactly one member is set.
JiraCloudProviderConfiguration:
type: object
properties:
ProjectKey:
type: string
description: The project key for a JiraCloud instance.
ServiceNowUpdateConfiguration:
type: object
properties:
SecretArn:
type: string
description: The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
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
DeleteConnectorV2Request:
type: object
properties:
ConnectorId:
type: string
description: The UUID of the connectorV2 to identify connectorV2 resource.
required:
- ConnectorId
ServiceQuotaExceededException:
type: object
properties:
Message:
type: string
Code:
type: string
AccessDeniedException:
type: object
properties:
Message:
type: string
Code:
type: string
JiraCloudUpdateConfiguration:
type: object
properties:
ProjectKey:
type: string
description: The project key for a JiraCloud instance.
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)