Modify a connector

put

https://{hostname}/crux/v1/mgmt-pop/agents/{uuid_url}

Updates an existing connector.

Path Params

uuid_url

string

required

A unique identifier for each connector.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

admin_pwd

string

length ≥ 1

Hash of the admin password.

advanced_settings

object

Connector advanced network settings.

agent_type

integer

enum

Defaults to 1

The type of connector. Either 1 for VM, 2 for IPSEC, or 3 for GRE.

Allowed:

agent_upgrade_enabled

boolean

Enables upgrades for the connector.

agent_upgrade_suspended

boolean

Suspends upgrades for a connector.

agent_version

string | null

The connector software version currently installed in the connector. For example, AGENT-4.3.0-2449+.

auth_service

boolean

Enables the authorization service.

capacity

object

Connector capacity data.

cpu

string | null

CPU of the connector. Specify null if you want to provide this later.

created_at

string

ISO 8601 timestamp marking the connector's creation.

data_service

boolean

Enables the data service.

debug_channel_permitted

boolean

Enables Akamai Support to run commands on the connector through the debug channel.

description

string | null

A description for the connector.

dhcp

string

length ≥ 1

Enables DHCP for the connector.

disk_size

integer | null

≥ 0

The disk size of the connector. Specify null if you want to provide this later.

dns_server

string | null

DNS Server of the connector. Specify null if you want to provide this later.

down_apps_count

integer

Count of down applications.

down_dir_count

integer

Count of down directories.

download_url

string | null

S3 URL to download the package. Specify null if you want to provide this later.

gateway

string | null

Gateway of the connector. Specify null if you want to provide this later.

geo_location

string | null

Geo-location of the connector. Specify null if you want to provide this later.

hostname

string | null

Machine name of the connector. Specify null if you want to provide this later.

ip_addr

string | null

IP address of the connector. Specify null if you want to provide this later.

last_checkin

string | null

ISO 8601 timestamp marking when the connector last checked in with the server.

last_stage_status

integer

enum

Status of the last staging. Either 1 for success or 4 for failure.

Allowed:

last_upgrade_failed_date

string

ISO 8601 timestamp marking the last upgrade failure.

last_upgrade_failed_in

string | null

enum

Location of the last upgrade failure, expressed as a string-formatted integer. Either 1 for none, 2 for pending, 3 for downloading, 4 for verifying, 5 for upgrade in progress, 6 for cleaning up, 7 for rollback in progress, 8 for completed, or 9 for metadata. Specify null if not applicable.

last_upgrade_status

integer

enum

Status of the last upgrade. Either 1 for success or 4 for failure.

Allowed:

last_upgrade_success_date

string

ISO 8601 timestamp marking the last successful upgrade.

last_upgrade_success_version

string | null

Last version of connector software successfully installed in the connector. Specify null if not applicable.

latest_stage_attempt_date

string | null

ISO 8601 timestamp of the last staging attempt. Specify null if not applicable.

latest_stage_attempt_version

string | null

Latest connector binary version staging attempted. Specify null if not applicable.

latest_upgrade_attempt_date

string | null

ISO 8601 timestamp of the last upgrade attempt. Specify null if not applicable.

latest_upgrade_attempt_state

string

length ≥ 1

Status of the last upgrade attempt on the connector.

latest_upgrade_attempt_version

string

length ≥ 1

Last version of connector software attempted on the connector.

load_status

string | null

enum

The connector load percentage status. 70% or more is High, 50 - 70% is Medium, and less than 50% is `Low``.

Allowed:

logging_settings

string

length ≥ 1

JSON-formatted logging settings.

mac

string | null

MAC address of the connector. Specify null if not applicable.

manual_override

boolean

When true, the connector cannot be upgraded.

modified_at

string

ISO 8601 timestamp marking the connector configuration's last modification.

name

string

length ≥ 1

Name of the connector.

os_upgrades_up_to_date

boolean

Whether the connector OS packages are up to date.

os_version

string | null

OS version of the connector.

package

integer

enum

Type of package for the connector. Refer to Connector package types for available values.

policy

string

length ≥ 1

The schedule policy ID for the connector.

private_ip

string | null

Private IP address of the connector.

public_ip

string | null

Public IP address of the connector.

pwd_comments

string | null

enum

Status of the set password attempt on the connector. Either Success or Failed.

Allowed:

pwdsyncflag

boolean

Enables sync of the connector password with the back-end database.

ram_size

integer | null

≥ 0

RAM size of the connector. Specify null if you want to provide this later.

reach

integer

enum

Defaults to 1

Connector reachability status. Either 0 for unreachable or 1 for reachable.

Allowed:

region

string | null

The region of the connector. For example, Central. Specify null if you want to provide this later.

resource_uri

object

Resource locations for the connector.

setpwd_attempt

integer

≥ 0

The number of unique password setting attempts.

state

integer

enum

Defaults to 0

State of the connector. Either 0 for not created, 1 for created, 2 for not installed, 3 for not verified, 4 for verified, 5 for unenrolled, 6 for enrolled, 7 for not configured, or 8 for configured.

status

integer

enum

Status of the connector. Either 0 for disabled or 1 for enabled.

Allowed:

subnet

string | null

Subnet of the connector. Specify null if you want to provide this later.

string | null

Time zone of the connector. For example, America/Los_Angeles.

up_apps_count

integer

Count of up applications.

up_dir_count

integer

Count of up directories.

uuid_url

string

length ≥ 1

A unique identifier for the connector.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful response.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

415Unsupported media type.