Update server details

put

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

Update server details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agentId

int32

required

≥ 0

Network agent ID

int32

required

≥ 0

Server ID

Body Params

Request object to update server details.

name

string

length between 1 and 512

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

vendor

string

enum

Vendor of server discovered by Network agent

Allowed:

connectionType

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.

port

int32

≥ 0

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

path

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

altPathForCert

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.

privateKeyPath

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.

passPhrase

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.

username

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.

password

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.

storeName

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.

storeCredId

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

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

Update response.

400

Bad Request

401Authentication information is missing or invalid.