Connectors

List Connectors

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · int32OptionalDefault: 100

page_tokenstring · nullableOptional

statusstring[] · nullableOptional

Responses

200

OK

application/json

get

/api/admin/v3/connectors

HTTPcURLJavaScriptPython

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

200

OK

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "status": "text",
      "version": "text",
      "last_connected": "text",
      "is_latest_version": true,
      "cloud_provider_type": "text",
      "sessions": [
        {
          "id": "text",
          "metadata": {
            "cloud_provider_metadata": {
              "kubernetes_type": "text",
              "kubernetes_version": "text",
              "is_kubernetes_admin": true,
              "local_deploy": true,
              "aws_account_id": "text",
              "region": "text",
              "availability_zone": "text",
              "project_id": "text",
              "organization_id": "text",
              "zone": "text",
              "subscription_id": "text",
              "resource_group": "text",
              "is_azure_admin": true
            },
            "connector_version": "text"
          },
          "last_connected_time": "text"
        }
      ]
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Get Connector

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

OK

application/json

idstringRequired

Unique identifier of the connector

namestringRequired

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

statusstringRequired

Operational state of the connector: CONNECTED or DISCONNECTED

versionstringRequired

Version of the Apono connector currently in use

last_connectedall of · nullableOptional

Timestamp of the most recent successful connector connection, in ISO 8601 format

string · date-timeOptional

ISO 8601 formatted date-time

is_latest_versionbooleanRequired

Indicates whether the most current version of the Apono connector is in use

cloud_provider_typestringRequired

Cloud provider to which the connector grants Apono access

get

/api/admin/v3/connectors/{id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "id": "text",
  "name": "text",
  "status": "text",
  "version": "text",
  "last_connected": "text",
  "is_latest_version": true,
  "cloud_provider_type": "text",
  "sessions": [
    {
      "id": "text",
      "metadata": {
        "cloud_provider_metadata": {
          "kubernetes_type": "text",
          "kubernetes_version": "text",
          "is_kubernetes_admin": true,
          "local_deploy": true,
          "aws_account_id": "text",
          "region": "text",
          "availability_zone": "text",
          "project_id": "text",
          "organization_id": "text",
          "zone": "text",
          "subscription_id": "text",
          "resource_group": "text",
          "is_azure_admin": true
        },
        "connector_version": "text"
      },
      "last_connected_time": "text"
    }
  ]
}

Update Connector

put

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestringRequired

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

Responses

200

OK

application/json

idstringRequired

Unique identifier of the connector

namestringRequired

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

statusstringRequired

Operational state of the connector: CONNECTED or DISCONNECTED

versionstringRequired

Version of the Apono connector currently in use

last_connectedall of · nullableOptional

Timestamp of the most recent successful connector connection, in ISO 8601 format

string · date-timeOptional

ISO 8601 formatted date-time

is_latest_versionbooleanRequired

Indicates whether the most current version of the Apono connector is in use

cloud_provider_typestringRequired

Cloud provider to which the connector grants Apono access

put

/api/admin/v3/connectors/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text"
}

200

OK

{
  "id": "text",
  "name": "text",
  "status": "text",
  "version": "text",
  "last_connected": "text",
  "is_latest_version": true,
  "cloud_provider_type": "text",
  "sessions": [
    {
      "id": "text",
      "metadata": {
        "cloud_provider_metadata": {
          "kubernetes_type": "text",
          "kubernetes_version": "text",
          "is_kubernetes_admin": true,
          "local_deploy": true,
          "aws_account_id": "text",
          "region": "text",
          "availability_zone": "text",
          "project_id": "text",
          "organization_id": "text",
          "zone": "text",
          "subscription_id": "text",
          "resource_group": "text",
          "is_azure_admin": true
        },
        "connector_version": "text"
      },
      "last_connected_time": "text"
    }
  ]
}

Delete Connector

delete

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204

No Content

delete

/api/admin/v3/connectors/{id}

HTTPcURLJavaScriptPython

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

204

No Content

No content

list connectors

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

connector_idstringRequired

last_connectedall of · nullableOptional

number · doubleOptionalExample: {seconds}.{nanos}

statusstringRequired

get

/api/v2/connectors

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "connector_id": "text",
    "last_connected": 1,
    "status": "text"
  }
]