Skip to Content
APIsPartners

Endpoints for platform administrators to manage access for third-party partners and applications. This API acts as the primary registry for partner integration and security.

Access Control: These endpoints are restricted to Platform Administrators. Managed via the Access Control Matrix.

Partner API Endpoints Summary

EndpointMethodOperation NameDescription
/partner-keysPOSTCreate Partner KeyRegister a new platform or application
/partner-keysGETList Partner KeysView all registered partner platforms
/partner-keys/\{key_uuid\}DELETERevoke Partner KeyImmediately invalidate a partner API key

Create Partner Key

POST /partner-keys

Register a new partner platform and generate a unique API key.

Request Body:

{ "partner_name": "DroneOps Fleet Management" }

Responses:

  • 201 Created:
{ "message": "Partner key generated", "data": { "key_uuid": "9a8b7c6d-5e4f-3210-abcd-ef9876543210", "partner_name": "DroneOps Fleet Management", "api_key": "udai_platform_abc123xyz456", "created_at": "2025-07-01T08:00:00Z" } }

List Partner Keys

GET /partner-keys

List all registered partner platforms and their status.

Responses:

  • 200 OK:
{ "data": [ { "key_uuid": "9a8b7c6d-5e4f-3210-abcd-ef9876543210", "partner_name": "DroneOps Fleet Management", "status": 1, "created_at": "2025-07-01T08:00:00Z" } ] }

Revoke Partner Key

DELETE /partner-keys/{key_uuid}

Revoke a partner API key. Once revoked, all requests using this key will be rejected with 403 Forbidden.

Responses:

  • 200 OK:
{ "message": "Partner key revoked successfully" }
Last updated on