Servers

The Servers API provides operations relate to Servers enrolled in an OPA Project.

Resolve Resource Names

Resolves enrolled resource names and returns any associated information and user access methods (UAMs)

SecuritybearerAuth
Request
Request Body schema: application/json
client_features
Array of strings

A list of features supported by the current sft client

include_user_access_methods
boolean

If true, the response includes the user access methods for the resource

names
required
Array of strings

A list of resource names to resolve

resource_type
string (ResolveResourceType)

The type of resource to resolve

Enum: "database" "server"
Responses
200

OK

post/v1/resolve
Request samples
application/json
{
  • "names": [
    • "api-server-west-01.example.com",
    • "db-node-east-01.example.com"
    ],
  • "client_features": [
    • "on-demand-users",
    • "gateways",
    • "ad-joined",
    • "gateway-brokered-rdp",
    • "user-access-methods",
    • "pam-password-account",
    • "pam-password-gateway"
    ],
  • "include_user_access_methods": true,
  • "resource_type": "database"
}
Response samples
application/json
{
  • "results": [
    • {
      }
    ]
}

List all Server Account Resources

Lists all Server Account Resources for the current Security Admin

This endpoint requires the following role: security_admin.

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

Responses
200

OK

get/v1/teams/{team_name}/all_server_accounts
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      }
    ]
}
List all Servers
Lists all Servers for your Team


This endpoint requires the following role: security_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
Responses 
200
OK


get/v1/teams/{team_name}/all_servers
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      }
    ]
}
List all Server Account Resources in a Resource group
Lists all Server Account Resources for the current Security Admin or Delegated Security Admin for the Resource Group


This endpoint requires one of the following roles: security_admin, delegated_security_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
resource_group_id
required
string
The UUID of a Resource Group


 
Responses 
200
OK


get/v1/teams/{team_name}/resource_groups/{resource_group_id}/all_server_accounts
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      }
    ]
}
List all Servers in a Project
Lists all Servers in a Project in a Resource Group


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
resource_group_id
required
string
The UUID of a Resource Group


 
project_id
required
string
The UUID of a Project


 
Responses 
200
OK


get/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      }
    ]
}
Retrieve a Server from a Project
Retrieves a Server from a Project in a Resource Group


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
resource_group_id
required
string
The UUID of a Resource Group


 
project_id
required
string
The UUID of a Project


 
server_id
required
string
The UUID of an enrolled Server


 
Responses 
200
OK


get/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers/{server_id}
Request samples 
Response samples 
application/json
{
  • "access_address": "string",
  • "alt_names": [
    • "string"
    ],
  • "bastion": "string",
  • "canonical_name": "string",
  • "cloud_provider": "aws",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "hostname": "string",
  • "id": "/regex/",
  • "instance_details": {
    • "account_id": "string",
    • "availability_zone": "string",
    • "instance_id": "string",
    • "instance_type": "string",
    • "networks": [
      ],
    • "public_ip_v4": "string",
    • "_type": "string"
    },
  • "labels": {
    • "property1": "string",
    • "property2": "string"
    },
  • "last_seen": "2019-08-24T14:15:22Z",
  • "managed": true,
  • "os": "string",
  • "os_type": "string",
  • "project_name": "string",
  • "registered_at": "2019-08-24T14:15:22Z",
  • "services": [
    • "string"
    ],
  • "sftd_version": "string",
  • "ssh_host_keys": [
    • "string"
    ],
  • "state": "string",
  • "team_name": "/regex/"
}
Delete a Server from a Project
Deletes a Server from a Project in a Resource Group


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
resource_group_id
required
string
The UUID of a Resource Group


 
project_id
required
string
The UUID of a Project


 
server_id
required
string
The UUID of an enrolled Server


 
Responses 
204
No Content


delete/v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers/{server_id}
Request samples