Connector

Get a list of connectors.

GET https://api.halosecurity.com/api/v1/connector/list.json

Returns a paginated list of connectors.

https://app.halosecurity.com/user/security/connectors/

Query Parameters

Name
Type
Description

name

String

Filter by name

type

Integer

Filter by type

Get a connector.

GET https://api.halosecurity.com/api/v1/connector/get.json

Returns a connectors

Name
Type
Description

id

Number

Id of connector

Delete a connector.

GET https://api.halosecurity.com/api/v1/connector/delete.json

Deletes a connectors

Name
Type
Description

id

Number

Id of connector

Create a connector.

GET https://api.halosecurity.com/api/v1/connector/create.json

Returns a connectors

Name
Type
Description

id

Number

Id of connector

auto_run_days

Number

name

String

type

String

aws, gcp, azure, http, cloudflare, godaddy

aws_region

String

aws_role_name

String

aws_account_id

String

azure_client_id

String

azure_client_secret

String

azure_tenant

String

azure_subscription_id

String

gcp_data

String

base64 encoded json

godaddy_api_key

String

godaddy_api_secret

String

http_url

URL

http_username

String

http_password

String

http_header_1_name

String

http_header_1_value

String

cloudflare_api_key

String

Update a connector.

GET https://api.halosecurity.com/api/v1/connector/update.json

Returns a connectors

Name
Type
Description

id

Number

Id of connector

auto_run_days

Number

name

String

Run a connector.

GET https://api.halosecurity.com/api/v1/connector/run.json

Runs a connectors

Name
Type
Description

id

Number

Id of connector

Last updated

© 2024 Halo Security