LogoLogo
API Reference
API Reference
  • API OVERVIEW
    • Getting started using Apono API
    • API Authentication
  • New Endpoints (Beta)
  • APONO
    • Groups
    • Access Flows
    • Bundles
    • Connectors
    • Users
    • Integrations
    • Access Bundles
    • Identities
    • Access Requests
    • Activity
    • Access Scopes
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. APONO

Connectors

PreviousBundlesNextUsers

Last updated 15 days ago

Was this helpful?

List Connectors

get
Authorizations
Query parameters
limitinteger · int32OptionalDefault: 100
page_tokenstring | nullableOptional
statusstring[] | nullableOptional
Responses
200
OK
application/json
get
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
Path parameters
idstringRequired
Responses
200
OK
application/json
get
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"
    }
  ]
}

Delete Connector

delete
Authorizations
Path parameters
idstringRequired
Responses
204
No Content
delete
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
Responses
200
OK
application/json
get
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"
  }
]
  • GETList Connectors
  • GETGet Connector
  • PUTUpdate Connector
  • DELETEDelete Connector
  • GETlist connectors

Update Connector

put
Authorizations
Path parameters
idstringRequired
Body
namestringRequired

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

Responses
200
OK
application/json
put
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"
    }
  ]
}