Integrations

list integrations

get

/api/v2/integrations

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v2/integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "status": "Initializing",
      "details": "text",
      "provisioner_id": "text",
      "metadata": {},
      "custom_access_details": "text",
      "connected_resource_types": [
        "text"
      ],
      "connection": {},
      "last_sync_time": 1,
      "secret_config": {}
    }
  ]
}

create integration

post

/api/v2/integrations

Authorizations

Body

namestringrequired

typestringrequired

provisioner_idstring | nullable

metadataobjectrequired

custom_access_detailsstring | nullable

connected_resource_typesstring[] | nullable

secret_configobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v2/integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","type":"text","metadata":{},"connected_resource_types":[null],"secret_config":{}}'

200

{
  "id": "text",
  "name": "text",
  "type": "text",
  "status": "Initializing",
  "details": "text",
  "provisioner_id": "text",
  "metadata": {},
  "custom_access_details": "text",
  "connected_resource_types": [
    "text"
  ],
  "connection": {},
  "last_sync_time": 1,
  "secret_config": {}
}

list integration configs

get

/api/v2/integrations-catalog

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v2/integrations-catalog' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "data": [
    {
      "name": "text",
      "type": "text",
      "description": "text",
      "requires_secret": true,
      "params": [
        {
          "id": "text",
          "label": "text",
          "default": "text",
          "optional": true,
          "values": [
            "text"
          ]
        }
      ],
      "supported_secret_types": [
        "text"
      ]
    }
  ]
}

get integration config

get

/api/v2/integrations-catalog/{type}

Authorizations

Path parameters

typestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v2/integrations-catalog/{type}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "name": "text",
  "type": "text",
  "description": "text",
  "requires_secret": true,
  "params": [
    {
      "id": "text",
      "label": "text",
      "default": "text",
      "optional": true,
      "values": [
        "text"
      ]
    }
  ],
  "supported_secret_types": [
    "text"
  ]
}

get integration

get

/api/v2/integrations/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v2/integrations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "text",
  "name": "text",
  "type": "text",
  "status": "Initializing",
  "details": "text",
  "provisioner_id": "text",
  "metadata": {},
  "custom_access_details": "text",
  "connected_resource_types": [
    "text"
  ],
  "connection": {},
  "last_sync_time": 1,
  "secret_config": {}
}

update integration

put

/api/v2/integrations/{id}

Authorizations

Path parameters

idstringrequired

Body

namestringrequired

provisioner_idstring | nullable

metadataobjectrequired

custom_access_detailsstring | nullable

connected_resource_typesstring[] | nullable

secret_configobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.apono.io/api/v2/integrations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","metadata":{},"connected_resource_types":[null],"secret_config":{}}'

200

{
  "id": "text",
  "name": "text",
  "type": "text",
  "status": "Initializing",
  "details": "text",
  "provisioner_id": "text",
  "metadata": {},
  "custom_access_details": "text",
  "connected_resource_types": [
    "text"
  ],
  "connection": {},
  "last_sync_time": 1,
  "secret_config": {}
}

delete integration

delete

/api/v2/integrations/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.apono.io/api/v2/integrations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "message": "text"
}

refresh integration

post

/api/v2/integrations/{id}/refresh

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v2/integrations/{id}/refresh' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "message": "text"
}

get user tags of a resource

get

/api/v3/integrations/resources/{resource_id}/user-tags

Authorizations

Path parameters

resource_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "resource_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

update user tags of a resource

put

/api/v3/integrations/resources/{resource_id}/user-tags

Authorizations

Path parameters

resource_idstringrequired

Body

tagsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"tags":{}}'

200

{
  "message": "text"
}

get integration permissions for the entire tenant

get

/api/v3/integrations/{id}/permissions

Authorizations

Path parameters

idstringrequired

Query parameters

resource-typestring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v3/integrations/{id}/permissions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "data": [
    {
      "name": "text",
      "id": "text",
      "resource_type": "text"
    }
  ]
}

get integration resources for the entire tenant

get

/api/v3/integrations/{id}/resources

Authorizations

Path parameters

idstringrequired

Query parameters

resource-typestring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v3/integrations/{id}/resources' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "status": {
        "status": "Active",
        "message": "text"
      }
    }
  ]
}