# Integration

## Get a list of integrations.

<mark style="color:blue;">`GET`</mark> `https://api.halosecurity.com/api/v1/integration/list.json`

Returns a paginated list of integrations.

<https://app.halosecurity.com/user/security/integrations/>

#### Query Parameters

<table><thead><tr><th width="137">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>name</td><td>String</td><td>Filter by name</td></tr><tr><td>type</td><td>Integer</td><td>Filter by type</td></tr></tbody></table>

## Get an integration.

<mark style="color:blue;">`GET`</mark> `https://api.halosecurity.com/api/v1/integration/get.json`

Returns an integration

<table><thead><tr><th width="137">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>Number</td><td>Id of integration</td></tr></tbody></table>

## Delete a integration.

<mark style="color:blue;">`GET`</mark> `https://api.halosecurity.com/api/v1/integration/delete.json`

Deletes an integration

<table><thead><tr><th width="137">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>Number</td><td>Id of integration</td></tr></tbody></table>

## Create a integration.

<mark style="color:blue;">`GET`</mark> `https://api.halosecurity.com/api/v1/integration/create.json`

Returns an integration

<table><thead><tr><th width="240">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>Number</td><td>Id of integration</td></tr><tr><td>auto_run_days</td><td>Number</td><td></td></tr><tr><td>name</td><td>String</td><td></td></tr><tr><td>type</td><td>String</td><td>aws, gcp, azure, http, cloudflare, godaddy</td></tr><tr><td>aws_region</td><td>String</td><td></td></tr><tr><td>aws_role_name</td><td>String</td><td></td></tr><tr><td>aws_account_id</td><td>String</td><td></td></tr><tr><td>azure_client_id</td><td>String</td><td></td></tr><tr><td>azure_client_secret</td><td>String</td><td></td></tr><tr><td>azure_tenant</td><td>String</td><td></td></tr><tr><td>azure_subscription_id</td><td>String</td><td></td></tr><tr><td>gcp_data</td><td>String</td><td>base64 encoded json</td></tr><tr><td>godaddy_api_key</td><td>String</td><td></td></tr><tr><td>godaddy_api_secret</td><td>String</td><td></td></tr><tr><td>http_url</td><td>URL</td><td></td></tr><tr><td>http_username</td><td>String</td><td></td></tr><tr><td>http_password</td><td>String</td><td></td></tr><tr><td>http_header_1_name</td><td>String</td><td></td></tr><tr><td>http_header_1_value</td><td>String</td><td></td></tr><tr><td>cloudflare_api_key</td><td>String</td><td></td></tr></tbody></table>

## Update an integration.

<mark style="color:blue;">`GET`</mark> `https://api.halosecurity.com/api/v1/integration/update.json`

Returns an integration

<table><thead><tr><th width="190">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>Number</td><td>Id of integration</td></tr><tr><td>auto_run_days</td><td>Number</td><td></td></tr><tr><td>name</td><td>String</td><td></td></tr></tbody></table>

## Run a integration.

<mark style="color:blue;">`GET`</mark> `https://api.halosecurity.com/api/v1/integration/run.json`

Runs an integration

<table><thead><tr><th width="190">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>Number</td><td>ID of integration</td></tr></tbody></table>