Update Proxy

Update Proxy

Update the name of a specific proxy

Request
URI
PUT
https://{api_host}/api/v2/proxy/{id}
COPY
Path Parameters
string
id
Required

id

Request Body

Example Body:

{
  "name": "New Name for proxy"
}
Proxy of type(s) application/json
Optional 
{
    "version": "string",
    "name": "string",
    "id": "string",
    "status": "string",
    "customerId": "string",
    "deleted": false,
    "lastCheckInTime": 0,
    "inTrash": false,
    "hostname": "string",
    "proxyname": "string",
    "lastKnownError": "string",
    "lastErrorTime": 0,
    "lastErrorEvent": {
        "computedHlps": [
            {
                "severity": "string",
                "host": "string",
                "startTime": 0,
                "label": "string",
                "observed": 0,
                "firing": 0
            }
        ],
        "table": "string",
        "name": "string",
        "id": "string",
        "startTime": 0,
        "endTime": 0,
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "tags": [
            "string"
        ],
        "metricsUsed": [
            "string"
        ],
        "createdAt": 0,
        "hosts": [
            "string"
        ],
        "summarizedEvents": 0,
        "alertTags": [
            "string"
        ],
        "isUserEvent": false,
        "isEphemeral": false,
        "creatorId": "string",
        "updaterId": "string",
        "updatedAt": 0,
        "runningState": "string",
        "canDelete": false,
        "canClose": false,
        "creatorType": [
            "string"
        ]
    },
    "timeDrift": 0,
    "bytesLeftForBuffer": 0,
    "bytesPerMinuteForBuffer": 0,
    "localQueueSize": 0,
    "sshAgent": false,
    "ephemeral": false,
    "shutdown": false,
    "truncate": false,
    "collectorSetsRateLimit": false,
    "collectorRateLimit": 0,
    "histogramRateLimit": 0,
    "sourceTagsRateLimit": "number",
    "eventsRateLimit": "number",
    "spanRateLimit": 0,
    "spanLogsRateLimit": 0,
    "preprocessorRules": "string",
    "userId": "string",
    "histoDisabled": false,
    "traceDisabled": false,
    "spanLogsDisabled": false,
    "logsDisabled": false,
    "statusCause": "string"
}
string
version
Optional

version

string
name
Required

Proxy name (modifiable)

string
id
Optional

id

string
status
Optional

the proxy's status

Possible values are : ACTIVE, STOPPED_UNKNOWN, STOPPED_BY_SERVER, TOKEN_EXPIRED,
string
customerId
Optional

customerId

boolean
deleted
Optional

deleted

integer As int64 As int64
lastCheckInTime
Optional

Last time when this proxy checked in (in milliseconds since the unix epoch)

boolean
inTrash
Optional

inTrash

string
hostname
Optional

Host name of the machine running the proxy

string
proxyname
Optional

Proxy name set by customer

string
lastKnownError
Optional

deprecated

integer As int64 As int64
lastErrorTime
Optional

deprecated

Event
lastErrorEvent
Optional

lastErrorEvent

integer As int64 As int64
timeDrift
Optional

Time drift of the proxy's clock compared to Wavefront servers

integer As int64 As int64
bytesLeftForBuffer
Optional

Number of bytes of space remaining in the persistent disk queue of this proxy

integer As int64 As int64
bytesPerMinuteForBuffer
Optional

Bytes used per minute by the persistent disk queue of this proxy

integer As int64 As int64
localQueueSize
Optional

Number of items in the persistent disk queue of this proxy

boolean
sshAgent
Optional

deprecated

boolean
ephemeral
Optional

When true, this proxy is expected to be ephemeral (possibly hosted on a short-lived container) and will be deleted after a period of inactivity (not checking in)

boolean
shutdown
Optional

When true, attempt to shut down this proxy remotely

boolean
truncate
Optional

When true, attempt to truncate down this proxy backlog remotely

boolean
collectorSetsRateLimit
Optional

When true, this proxy's rate limit is controlled remotely

integer As int64 As int64
collectorRateLimit
Optional

Proxy's rate limit

integer As int64 As int64
histogramRateLimit
Optional

Proxy's rate limit for histograms

number As double As double
sourceTagsRateLimit
Optional

Proxy's rate limit for source tag operations

number As double As double
eventsRateLimit
Optional

Proxy's rate limit for events

integer As int64 As int64
spanRateLimit
Optional

Proxy's rate limit for spans

integer As int64 As int64
spanLogsRateLimit
Optional

Proxy's rate limit for span logs

string
preprocessorRules
Optional

Proxy's preprocessor rules

string
userId
Optional

The user associated with this proxy

boolean
histoDisabled
Optional

Proxy's histogram feature disabled

boolean
traceDisabled
Optional

Proxy's spans feature disabled

boolean
spanLogsDisabled
Optional

Proxy's span logs feature disabled

boolean
logsDisabled
Optional

Proxy's logs feature disabled for customer

string
statusCause
Optional

The reason why the proxy is in current status

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerProxy of type(s) application/json 
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "version": "string",
        "name": "string",
        "id": "string",
        "status": "string",
        "customerId": "string",
        "deleted": false,
        "lastCheckInTime": 0,
        "inTrash": false,
        "hostname": "string",
        "proxyname": "string",
        "lastKnownError": "string",
        "lastErrorTime": 0,
        "lastErrorEvent": {
            "computedHlps": [
                {
                    "severity": "string",
                    "host": "string",
                    "startTime": 0,
                    "label": "string",
                    "observed": 0,
                    "firing": 0
                }
            ],
            "table": "string",
            "name": "string",
            "id": "string",
            "startTime": 0,
            "endTime": 0,
            "createdEpochMillis": 0,
            "updatedEpochMillis": 0,
            "tags": [
                "string"
            ],
            "metricsUsed": [
                "string"
            ],
            "createdAt": 0,
            "hosts": [
                "string"
            ],
            "summarizedEvents": 0,
            "alertTags": [
                "string"
            ],
            "isUserEvent": false,
            "isEphemeral": false,
            "creatorId": "string",
            "updaterId": "string",
            "updatedAt": 0,
            "runningState": "string",
            "canDelete": false,
            "canClose": false,
            "creatorType": [
                "string"
            ]
        },
        "timeDrift": 0,
        "bytesLeftForBuffer": 0,
        "bytesPerMinuteForBuffer": 0,
        "localQueueSize": 0,
        "sshAgent": false,
        "ephemeral": false,
        "shutdown": false,
        "truncate": false,
        "collectorSetsRateLimit": false,
        "collectorRateLimit": 0,
        "histogramRateLimit": 0,
        "sourceTagsRateLimit": "number",
        "eventsRateLimit": "number",
        "spanRateLimit": 0,
        "spanLogsRateLimit": 0,
        "preprocessorRules": "string",
        "userId": "string",
        "histoDisabled": false,
        "traceDisabled": false,
        "spanLogsDisabled": false,
        "logsDisabled": false,
        "statusCause": "string"
    }
}
ResponseStatus
status
Required

status

Proxy
response
Optional

response


On This Page
Proxy Operations
DELETE
Delete Proxy
GET
Get All Proxy
GET
Get Proxy
GET
Get Proxy Config
GET
Get Proxy Preprocessor Rules
POST
Undelete Proxy
PUT
Update Proxy