Integrations

list Integrations

get

Authorizations

Query parameters

categorystring[] | nullableOptional

connector_idstring[] | nullableOptional

limitinteger · int32OptionalDefault: 100

namestring | nullableOptional

page_tokenstring | nullableOptional

statusstring[] | nullableOptional

typestring[] | nullableOptional

Responses

200

OK

application/json

get

GET /api/admin/v4/integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "category": "text",
      "connector_id": "text",
      "status": "text",
      "last_sync_time": "text",
      "integration_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "secret_store_config": {
        "aws": {
          "region": "text",
          "secret_id": "text"
        },
        "gcp": {
          "project": "text",
          "secret_id": "text"
        },
        "kubernetes": {
          "namespace": "text",
          "name": "text"
        },
        "azure": {
          "vault_url": "text",
          "name": "text"
        },
        "hashicorp_vault": {
          "secret_engine": "text",
          "path": "text"
        },
        "apono": {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "connected_resource_types": [
        "text"
      ],
      "custom_access_details": "text",
      "owner": {
        "attribute_type": "text",
        "attribute_value": [
          "text"
        ],
        "source_integration_id": "text",
        "source_integration_name": "text"
      },
      "owners_mapping": {
        "key_name": "text",
        "attribute_type": "text",
        "source_integration_id": "text",
        "source_integration_name": "text"
      }
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Integration

post

Authorizations

Body

namestringRequired

Unique, alphanumeric, user-friendly name used to identify the integration

typestringRequired

Apono-defined identifier for the specific integration type

connector_idstring | nullableOptional

Unique identifier of the Apono connector

integration_configall ofRequired

Set of integration-specific connection and management parameters. Refer to the Integration Configuration documentation for specific configuration values.

secret_store_configall of | nullableOptional

connected_resource_typesstring[] | nullableOptional

List of discoverable resource types within the integration

custom_access_detailsstring | nullableOptional

Admin custom instructions (max 400 characters) for accessing the integration’s resources, shown to end users

ownerall of | nullableOptional

owners_mappingall of | nullableOptional

Responses

200

OK

application/json

post

POST /api/admin/v4/integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 635

{
  "name": "text",
  "type": "text",
  "connector_id": "text",
  "integration_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secret_store_config": {
    "aws": {
      "region": "text",
      "secret_id": "text"
    },
    "gcp": {
      "project": "text",
      "secret_id": "text"
    },
    "kubernetes": {
      "namespace": "text",
      "name": "text"
    },
    "azure": {
      "vault_url": "text",
      "name": "text"
    },
    "hashicorp_vault": {
      "secret_engine": "text",
      "path": "text"
    }
  },
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text",
  "owner": {
    "attribute_type": "text",
    "attribute_value": [
      "text"
    ],
    "source_integration_reference": "text"
  },
  "owners_mapping": {
    "key_name": "text",
    "attribute_type": "text",
    "source_integration_reference": "text"
  }
}

200

OK

{
  "id": "text",
  "name": "text",
  "type": "text",
  "category": "text",
  "connector_id": "text",
  "status": "text",
  "last_sync_time": "text",
  "integration_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secret_store_config": {
    "aws": {
      "region": "text",
      "secret_id": "text"
    },
    "gcp": {
      "project": "text",
      "secret_id": "text"
    },
    "kubernetes": {
      "namespace": "text",
      "name": "text"
    },
    "azure": {
      "vault_url": "text",
      "name": "text"
    },
    "hashicorp_vault": {
      "secret_engine": "text",
      "path": "text"
    },
    "apono": {
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text",
  "owner": {
    "attribute_type": "text",
    "attribute_value": [
      "text"
    ],
    "source_integration_id": "text",
    "source_integration_name": "text"
  },
  "owners_mapping": {
    "key_name": "text",
    "attribute_type": "text",
    "source_integration_id": "text",
    "source_integration_name": "text"
  }
}

Get Integration By Id

get

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

get

GET /api/admin/v4/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "name": "text",
  "type": "text",
  "category": "text",
  "connector_id": "text",
  "status": "text",
  "last_sync_time": "text",
  "integration_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secret_store_config": {
    "aws": {
      "region": "text",
      "secret_id": "text"
    },
    "gcp": {
      "project": "text",
      "secret_id": "text"
    },
    "kubernetes": {
      "namespace": "text",
      "name": "text"
    },
    "azure": {
      "vault_url": "text",
      "name": "text"
    },
    "hashicorp_vault": {
      "secret_engine": "text",
      "path": "text"
    },
    "apono": {
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text",
  "owner": {
    "attribute_type": "text",
    "attribute_value": [
      "text"
    ],
    "source_integration_id": "text",
    "source_integration_name": "text"
  },
  "owners_mapping": {
    "key_name": "text",
    "attribute_type": "text",
    "source_integration_id": "text",
    "source_integration_name": "text"
  }
}

Update Integration

put

Authorizations

Path parameters

idstringRequired

Body

namestringRequired

Unique, alphanumeric, user-friendly name used to identify the integration

integration_configall ofRequired

Set of integration-specific connection and management parameters

secret_store_configall of | nullableOptional

connected_resource_typesstring[] | nullableOptional

List of discoverable resource types within the integration

custom_access_detailsstring | nullableOptional

Admin custom instructions (max 400 characters) for accessing the integration’s resources, shown to end users

ownerall of | nullableOptional

owners_mappingall of | nullableOptional

Responses

200

OK

application/json

put

PUT /api/admin/v4/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 599

{
  "name": "text",
  "integration_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secret_store_config": {
    "aws": {
      "region": "text",
      "secret_id": "text"
    },
    "gcp": {
      "project": "text",
      "secret_id": "text"
    },
    "kubernetes": {
      "namespace": "text",
      "name": "text"
    },
    "azure": {
      "vault_url": "text",
      "name": "text"
    },
    "hashicorp_vault": {
      "secret_engine": "text",
      "path": "text"
    }
  },
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text",
  "owner": {
    "attribute_type": "text",
    "attribute_value": [
      "text"
    ],
    "source_integration_reference": "text"
  },
  "owners_mapping": {
    "key_name": "text",
    "attribute_type": "text",
    "source_integration_reference": "text"
  }
}

200

OK

{
  "id": "text",
  "name": "text",
  "type": "text",
  "category": "text",
  "connector_id": "text",
  "status": "text",
  "last_sync_time": "text",
  "integration_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secret_store_config": {
    "aws": {
      "region": "text",
      "secret_id": "text"
    },
    "gcp": {
      "project": "text",
      "secret_id": "text"
    },
    "kubernetes": {
      "namespace": "text",
      "name": "text"
    },
    "azure": {
      "vault_url": "text",
      "name": "text"
    },
    "hashicorp_vault": {
      "secret_engine": "text",
      "path": "text"
    },
    "apono": {
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text",
  "owner": {
    "attribute_type": "text",
    "attribute_value": [
      "text"
    ],
    "source_integration_id": "text",
    "source_integration_name": "text"
  },
  "owners_mapping": {
    "key_name": "text",
    "attribute_type": "text",
    "source_integration_id": "text",
    "source_integration_name": "text"
  }
}

Delete Integration

delete

Authorizations

Path parameters

idstringRequired

Responses

204

No Content

delete

DELETE /api/admin/v4/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

list integrations

get

Authorizations

Responses

200

OK

application/json

get

GET /api/v2/integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

create integration

post

Authorizations

Body

namestringRequired

typestringRequired

provisioner_idstring | nullableOptional

metadataobjectRequired

secret_configall of | nullableOptional

objectOptional

connected_resource_typesstring[] | nullableOptional

custom_access_detailsstring | nullableOptional

Responses

200

OK

application/json

post

POST /api/v2/integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "name": "text",
  "type": "text",
  "provisioner_id": "text",
  "metadata": {},
  "secret_config": {},
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text"
}

200

OK

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

list integration configs

get

Authorizations

Responses

200

OK

application/json

get

GET /api/v2/integrations-catalog HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

get integration config

get

Authorizations

Path parameters

typestringRequired

Responses

200

OK

application/json

get

GET /api/v2/integrations-catalog/{type} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

get integration

get

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

get

GET /api/v2/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

update integration

put

Authorizations

Path parameters

idstringRequired

Body

namestringRequired

provisioner_idstring | nullableOptional

metadataobjectRequired

secret_configall of | nullableOptional

objectOptional

connected_resource_typesstring[] | nullableOptional

custom_access_detailsstring | nullableOptional

Responses

200

OK

application/json

put

PUT /api/v2/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "text",
  "provisioner_id": "text",
  "metadata": {},
  "secret_config": {},
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text"
}

200

OK

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

delete integration

delete

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

delete

DELETE /api/v2/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "message": "text"
}

refresh integration

post

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

post

POST /api/v2/integrations/{id}/refresh HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "message": "text"
}

get user tags of a resource

get

Authorizations

Path parameters

resource_idstringRequired

Responses

200

OK

application/json

get

GET /api/v3/integrations/resources/{resource_id}/user-tags HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

update user tags of a resource

put

Authorizations

Path parameters

resource_idstringRequired

Body

Responses

200

OK

application/json

put

PUT /api/v3/integrations/resources/{resource_id}/user-tags HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

{
  "message": "text"
}

get integration permissions for the entire tenant

get

Authorizations

Path parameters

idstringRequired

Query parameters

resource-typestring | nullableOptional

Responses

200

OK

application/json

get

GET /api/v3/integrations/{id}/permissions HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

get integration resources for the entire tenant

get

Authorizations

Path parameters

idstringRequired

Query parameters

resource-typestring | nullableOptional

Responses

200

OK

application/json

get

GET /api/v3/integrations/{id}/resources HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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