Integrations

list integrations

GEThttps://api.apono.io/api/v2/integrations

Response

200

OK

Body

application/json

data*array of Integration (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

create integration

POSThttps://api.apono.io/api/v2/integrations

Body

application/json

name*string

type*string

provisioner_idnullable string

metadata*object

secret_confignullable object

connected_resource_typesnullable array of string

custom_access_detailsnullable string

Response

200

OK

Body

application/json

id*string

name*string

type*string

status*IntegrationStatus (enum)

InitializingRefreshingActiveErrorWarningDisabled

detailsnullable string

provisioner_idnullable string

connectionnullable object

last_sync_timenullable number

metadata*object

secret_confignullable object

connected_resource_types*array of string

custom_access_detailsnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

200

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

list integration configs

GEThttps://api.apono.io/api/v2/integrations-catalog

Response

200

OK

Body

application/json

data*array of IntegrationConfig (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations-catalog', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

get integration config

GEThttps://api.apono.io/api/v2/integrations-catalog/{type}

Path parameters

type*string

Response

200

OK

Body

application/json

name*string

type*string

description*string

params*array of IntegrationConfigParam (object)

requires_secret*boolean

supported_secret_types*array of string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations-catalog/{type}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

get integration

GEThttps://api.apono.io/api/v2/integrations/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

id*string

name*string

type*string

status*IntegrationStatus (enum)

InitializingRefreshingActiveErrorWarningDisabled

detailsnullable string

provisioner_idnullable string

connectionnullable object

last_sync_timenullable number

metadata*object

secret_confignullable object

connected_resource_types*array of string

custom_access_detailsnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

update integration

PUThttps://api.apono.io/api/v2/integrations/{id}

Path parameters

id*string

Body

application/json

name*string

provisioner_idnullable string

metadata*object

secret_confignullable object

connected_resource_typesnullable array of string

custom_access_detailsnullable string

Response

200

OK

Body

application/json

id*string

name*string

type*string

status*IntegrationStatus (enum)

InitializingRefreshingActiveErrorWarningDisabled

detailsnullable string

provisioner_idnullable string

connectionnullable object

last_sync_timenullable number

metadata*object

secret_confignullable object

connected_resource_types*array of string

custom_access_detailsnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

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

delete integration

DELETEhttps://api.apono.io/api/v2/integrations/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

message*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "text"
}

refresh integration

POSThttps://api.apono.io/api/v2/integrations/{id}/refresh

Path parameters

id*string

Response

200

OK

Body

application/json

message*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v2/integrations/{id}/refresh', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "text"
}

get user tags of a resource

GEThttps://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags

Path parameters

resource_id*string

Response

200

OK

Body

application/json

resource_id*string

tags*object

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "resource_id": "text"
}

update user tags of a resource

PUThttps://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags

Path parameters

resource_id*string

Body

application/json

tags*object

Response

200

OK

Body

application/json

message*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "message": "text"
}

get integration permissions for the entire tenant

GEThttps://api.apono.io/api/v3/integrations/{id}/permissions

Path parameters

id*string

Query parameters

Response

200

OK

Body

application/json

data*array of PermissionV3 (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/integrations/{id}/permissions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

get integration resources for the entire tenant

GEThttps://api.apono.io/api/v3/integrations/{id}/resources

Path parameters

id*string

Query parameters

Response

200

OK

Body

application/json

data*array of ResourceResponse (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/integrations/{id}/resources', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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