Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Instana User API

The User API from Instana — 7 operation(s) for user.

Instana User API is one of 62 APIs that Instana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 7 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.307.1417.

Requests are made against 2 base URLs: https://{unit}-{tenant}.instana.io, https://{domain}.

10 operations 7 paths 6 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.307.1417
Servers
https://{unit}-{tenant}.instana.io
https://{domain}
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Instana User API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (ApiKeyAuth).

  • ApiKeyAuth — Example bash curl --request GET \ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \ --header 'authorization: apiToken xxxxxxxx…

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

User 10
POST
/api/settings/invitation/share
Send user invitations
shareAndInviteUsers body → 200400
DELETE
/api/settings/invitations
Revoke pending invitation
revokePendingInvitation 1 param → default
GET
/api/settings/invitations
All pending invitations
getInvitations → 200
POST
/api/settings/invitations
Send user invitations
inviteUsers body → 200400
GET
/api/settings/users
All users (without invitations)
getUsers → 200401403
PUT
/api/settings/users/delete
Remove users from tenant
removeUsersFromTenant body → 204401403
GET
/api/settings/users/overview
All users (incl. invitations)
getUsersIncludingInvitations → 200401403
PUT
/api/settings/users/{email}
Change user name of single user
updateUser 1 param body → 204401403404
DELETE
/api/settings/users/{userId}
Remove user from tenant
removeUserFromTenant 1 param → 204401403
GET
/api/settings/users/{userId}
Get single user
getUserById 1 param → 200401403

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are UserResult (6 properties), Invitation (4 properties), UsersResult (2 properties), InvitationResult (2 properties). Each schema is shown below with its type and property counts.

InvitationResponse
object
1 property
EditUser
object
1 property 1 required
InvitationResult
object
2 properties
UsersResult
object
2 properties
UserResult
object
6 properties 3 required
Invitation
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-user-api-openapi.yml Raw ↑

Other APIs Instana publishes across the network.

Instana Action Catalog API
Instana Action History API
Instana AI Management API
Instana Apdex Report API
Instana Apdex Settings API
Instana API Token API
Instana Application Alert Configuration API
Instana Application Analyze API
Instana Application Catalog API
Instana Application Metrics API
Instana Application Resources API
Instana Application Settings API