Integrations
100
GET /api/admin/v4/integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
}
Unique, alphanumeric, user-friendly name used to identify the integration
Apono-defined identifier for the specific integration type
Unique identifier of the Apono connector
Set of integration-specific connection and management parameters. Refer to the Integration Configuration documentation for specific configuration values.
List of discoverable resource types within the integration
Admin custom instructions (max 400 characters) for accessing the integration’s resources, shown to end users
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"
}
}
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 /api/admin/v4/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
}
Unique, alphanumeric, user-friendly name used to identify the integration
Set of integration-specific connection and management parameters
List of discoverable resource types within the integration
Admin custom instructions (max 400 characters) for accessing the integration’s resources, shown to end users
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"
}
}
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 /api/v2/integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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
}
}
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"
}
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"
}
GET /api/v2/integrations-catalog HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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 /api/v2/integrations-catalog/{type} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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 /api/v2/integrations/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}
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"
}
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"
}
GET /api/v3/integrations/resources/{resource_id}/user-tags HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"resource_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
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"
}
}
OK
{
"message": "text"
}
GET /api/v3/integrations/{id}/permissions HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"data": [
{
"name": "text",
"id": "text",
"resource_type": "text"
}
],
"pagination": {
"total": 1,
"limit": 1,
"offset": 1
}
}
GET /api/v3/integrations/{id}/resources HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"data": [
{
"id": "text",
"name": "text",
"type": "text",
"status": {
"status": "Active",
"message": "text"
}
}
],
"pagination": {
"total": 1,
"limit": 1,
"offset": 1
}
}
Last updated
Was this helpful?