Skip to content

Check Site Exist.

POST
/api/data/namespaces/system/site/{name}/status
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/site/example/status \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "end_time": "example", "name": "example", "start_time": "example" }'

Check Site Exist for a site.

Examples of this operation.

name
required
string

Name

x-required Name of the site.

Media typeapplication/json
Check Site Exist Request

Request to GET status for a site.

object
end_time
End time

End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339

Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to

string
<= 1024 characters
name
Name

Name of the site Required: YES.

string
>= 6 characters <= 1024 characters
start_time
Start time

Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339

Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.

string
<= 1024 characters
Examplegenerated
{
"end_time": "example",
"name": "example",
"start_time": "example"
}

A successful response.

Media typeapplication/json
Check Site Exist Response

Response for the Check Site Exist Request.

object
status
string
default: NOT_FOUND
Allowed values: NOT_FOUND FOUND
Example
{
"status": "NOT_FOUND"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example