API Reference

Add server

post
https://admin.{instance}.sectigo.com/api/agent/v1/network//server

Add a new server to a Network Agent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 0

Network agent ID

Body Params

Request object to add server to Network agent.

string
required
length between 1 and 512

Name of server discovered by Network agent. Must be not blank.

string
enum
required

Vendor of server discovered by Network agent

Allowed:
string
enum

Connection type to server discovered by Network agent. Must be specified.

Allowed:
string
length between 0 and 255

Hostname or IP address of server that's creating as one discovered by Network agent. Required for a remote server.

int32
≥ 0

Port number on server discovered by Network agent. Required for a remote server and for all except 'Microsoft IIS' vendors.

string
length between 0 and 512

Path to root directory(in case of 'Apache Tomcat' vendor) or to the 'apachectl' executable(in case of 'Apache' vendor) of server discovered by Network agent. Can be specified only for listed vendors. Optional

string

Alternative path to a directory where server discovered by Network agent stores certificates. Can be specified for a remote server and for 'Apache' vendor only. Optional.

string
length between 0 and 128

Path to a directory where Network agent stores private key to authenticate on discovered server. Can be specified for a remote server and for 'Apache' and 'Apache Tomcat' vendors only. Must be used in conjunction with 'passPhrase' but not with 'username'/'password' parameters and not with 'storeName'/'storeCredId' parameters. Optional.

string

Passphrase to gain access to keystore where Network agent preserves the private key to authenticate on discovered server. Can be specified for a remote server and for 'Apache' and 'Apache Tomcat' vendors only. Used together with 'privateKeyPath' but not with 'username'/'password' parameters and not with 'storeName'/'storeCredId' parameters. Optional.

string
length between 0 and 64

Username(login) to gain access to server discovered by Network agent. Can be specified for a remote server and for all vendors. Must be used in conjunction with 'password' or 'privateKeyPath'/'passPhrase' parameters and not with 'storeName'/'storeCredId' parameters. Optional.

string

Password for username to gain access to server discovered by Network agent. Can be specified for a remote server and for all vendors. Used together with 'username' but not with 'privateKeyPath'/'passPhrase' parameters and not with 'storeName'/'storeCredId' parameters. Optional.

string

Store name to gain access to server discovered by Network agent. Can be specified for a remote server and for 'Apache' and 'Apache Tomcat' vendors only. Must be used in conjunction with 'storeCredId' but not with 'username'/'password' parameters and not with 'privateKeyPath'/'passPhrase' parameters. Optional.

string

Store credential ID to gain access to server discovered by Network agent. Can be specified for a remote server and for 'Apache' and 'Apache Tomcat' vendors only. Must be used in conjunction with 'storeName' but not with 'username'/'password' parameters and not with 'privateKeyPath'/'passPhrase' parameters. Optional.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Bad Request

Updated 5 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 5 months ago