Topology service (v1)

Download OpenAPI specification:Download

co.brick: aiops@cobrick.com URL: https://cobrick.com License: Commercial

topology

Get topology

Returns list of basic information about services and their connections

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

null

Cleanup old topology data

Removes topology related resources which were not "seen" for a longer period of time

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

{"removedItems": {"property1": 0,
"property2": 0
}
}

Trigger background topology update operation

Triggers an operation which updates the database with topology data. The method returns immediately, while the operation is executed asynchronously

query Parameters

firstRun

boolean

Default: false

Parameter determining an initial, first run topology update for the tenant

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

addresses

Get addresses

Returns list of addresses

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

null

Create or update an address mapping

Creates or updates an address mapping entry

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Request Body schema: application/json
required

JSON representation of the address to be created/updated

namespace required	string
country required	string
city required	string
zipCode required	string
street required	string

Responses

Request samples

Payload

Content type

application/json

{"namespace": "string",
"country": "string",
"city": "string",
"zipCode": "string",
"street": "string"
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Remove an address

Removes an address mapping for a given namespace

path Parameters

namespace required	string
required	string or string Namespace

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

health

Get grouped health statuses divided for resource type

query Parameters

node	string The node filter

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

{"services": {"HEALTHY": 0,
"UNHEALTHY": 0,
"UNKNOWN": 0,
"COMPLETED": 0
},
"pods": {"HEALTHY": 0,
"UNHEALTHY": 0,
"UNKNOWN": 0,
"COMPLETED": 0
},
"nodes": {"HEALTHY": 0,
"UNHEALTHY": 0,
"UNKNOWN": 0,
"COMPLETED": 0
}
}

log templates

Get log templates

query Parameters

boolean or boolean

Should templates with invalid names be included in the response

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

null

nodes

Get nodes

Returns list of nodes

query Parameters

deleted	boolean If set to true, returns only deleted nodes, false returns non-deleted, or all when not set
serviceName	Array of strings >= 0 items Service name
	Array of strings or Array of strings Service namespace
health	Array of strings (HealthStatus) >= 0 items Items Enum: "HEALTHY" "UNHEALTHY" "UNKNOWN" "COMPLETED" The health status filter

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

null

Create or update a node

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Request Body schema: application/json
required

JSON representation of the node to be created/updated

name required	string
required	object (K8sNodeResources)
required	object (K8sNodeConfiguration)
statistics	string <json>
statusChangeTime required	string <date-time>
lastSeen	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"resources": {"capacity": {"property1": "string",
"property2": "string"
},
"allocatable": {"property1": "string",
"property2": "string"
}
},
"configuration": {"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
],
"nodeInfo": {"property1": "string",
"property2": "string"
}
},
"statistics": "string",
"statusChangeTime": "2019-08-24T14:15:22Z",
"lastSeen": "2019-08-24T14:15:22Z"
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get node details

path Parameters

required

string or string

Node name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
404
500

Content type

application/json

{"name": "string",
"resources": {"capacity": {"property1": "string",
"property2": "string"
},
"allocatable": {"property1": "string",
"property2": "string"
}
},
"configuration": {"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
],
"nodeInfo": {"property1": "string",
"property2": "string"
}
},
"statistics": "string",
"status": "HEALTHY",
"statusChecks": [{"description": "string",
"checks": [{"result": "PASSED",
"details": "string"
}
],
"status": "HEALTHY",
"passedCount": 0,
"totalCount": 0
}
],
"statusChangeTime": "2019-08-24T14:15:22Z",
"lastSeen": "2019-08-24T14:15:22Z",
"deleted": true
}

Remove a node

Removes a cluster node

path Parameters

required

string or string

Node name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get node pods

Returns list of pods for a node

path Parameters

required

string or string

Node name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

null

pods

Get pods

Returns a list of pods with basic information about them

query Parameters

node	Array of strings >= 0 items The node filter
serviceNamespace	Array of strings >= 0 items Service namespace
	Array of strings or Array of strings Service name
	boolean or boolean If set to true, returns only deleted services, false returns non-deleted, or all when not set
health	Array of strings (HealthStatus) >= 0 items Items Enum: "HEALTHY" "UNHEALTHY" "UNKNOWN" "COMPLETED" The health status filter

header Parameters

Api-Version	string API version
X-Scope-OrgID	string Tenant header

Responses

Response samples

200
400
401
500

Content type

application/json

null

services

Get services

Returns a list of services with basic information about them

query Parameters

edge	boolean If set to true, returns only edge services, false returns non-edge services, or all when not set
namespace	string The namespace filter
	string or string Return the service containing given pod
withMetrics	boolean Default: false If set to true limits the result to services with active metrics
health	string (HealthStatus) Enum: "HEALTHY" "UNHEALTHY" "UNKNOWN" "COMPLETED" The health status filter
type	string The type service filter
	boolean or boolean If set to true limits the result to services with active log templates
	boolean or boolean If set to true, returns only deleted services, false returns non-deleted, or all when not set
node	string The node filter

header Parameters

Api-Version	string API version
X-Scope-OrgID	string Tenant header

Responses

Response samples

200
400
401
500

Content type

application/json

null

Create or update a service

header Parameters

X-Scope-OrgID	string Tenant header
	string or string User-Agent header
Api-Version	string API version

Request Body schema: application/json
required

A JSON representation of a service

name required	string
namespace required	string
type required	string
technology required	string (ServiceTechnology) Enum: "JAVA" "CSHARP" "NODEJS" "PHP" "OTHER"
edge required	boolean
endpoints required	Array of strings
required	object (ServiceConfiguration)
statistics	string <json>
statusChangeTime required	string <date-time>
rawObject	string <json>
patch	string
media required	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"namespace": "string",
"type": "string",
"technology": "JAVA",
"edge": true,
"endpoints": ["string"
],
"configuration": {"replicas": 0,
"availableReplicas": 0,
"readyReplicas": 0,
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"statistics": "string",
"statusChangeTime": "2019-08-24T14:15:22Z",
"rawObject": "string",
"patch": "string",
"media": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get services with facets

Returns a list of services basic information with facets metadata

query Parameters

edge	boolean If set to true, returns only edge services, false returns non-edge services, or all when not set
groupBy	string If set returns services grouped by the field from the parameter
namespace	string The namespace filter
withMetrics	boolean Default: false If set to true limits the result to services with active metrics
health	string (HealthStatus) Enum: "HEALTHY" "UNHEALTHY" "UNKNOWN" "COMPLETED" The health status filter
type	string The type service filter
	boolean or boolean If set to true limits the result to services with active log templates
	boolean or boolean If set to true, returns only deleted services, false returns non-deleted, or all when not set
node	string The node filter

header Parameters

Api-Version	string API version
X-Scope-OrgID	string Tenant header

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"key": "string",
"values": [{"namespace": "string",
"name": "string",
"type": "string",
"technology": "JAVA",
"edge": true,
"status": "HEALTHY",
"statusChangeTime": "2019-08-24T14:15:22Z",
"deleted": true
}
],
"status": "HEALTHY"
}
],
"facets": [{"id": "string",
"name": "string",
"values": [{"id": "string",
"name": "string",
"count": 0
}
]
}
]
}

Get all namespaces

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

null

Get service details

Returns a service with corresponding metrics and log templates

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"name": "string",
"namespace": "string",
"type": "string",
"address": {"namespace": "string",
"country": "string",
"city": "string",
"zipCode": "string",
"street": "string"
},
"technology": "JAVA",
"edge": true,
"endpoints": ["string"
],
"configuration": {"replicas": 0,
"availableReplicas": 0,
"readyReplicas": 0,
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"statistics": "string",
"status": "HEALTHY",
"statusChecks": [{"description": "string",
"checks": [{"result": "PASSED",
"details": "string"
}
],
"status": "HEALTHY",
"passedCount": 0,
"totalCount": 0
}
],
"statusChangeTime": "2019-08-24T14:15:22Z",
"rawObject": "string",
"lastSeen": "2019-08-24T14:15:22Z",
"media": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"deleted": true,
"metrics": [{"name": "string",
"type": "GAUGE",
"category": "string",
"main": true,
"lastSeen": "2019-08-24T14:15:22Z"
}
],
"logTemplates": [{"id": 0,
"name": "string",
"namespace": "string",
"ownerService": "string",
"ownerNode": "string",
"tokens": ["string"
],
"container": "string",
"lastSeen": "2019-08-24T14:15:22Z"
}
],
"resources": {"pod": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"nodes": [{"name": "string",
"capacity": {"property1": "string",
"property2": "string"
},
"allocatable": {"property1": "string",
"property2": "string"
}
}
]
}
}

Remove a service

Removes a service

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get a list of service containers with basic information

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

null

Get service endpoints

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
404
500

Content type

application/json

["string"
]

Store service endpoints

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
	string or string User-Agent header
Api-Version	string API version

Request Body schema: application/json
required

A JSON array of the endpoints to be stored

One of

>= 0 items

Array (>= 0 items)

string

Responses

Request samples

Payload

Content type

application/json

null

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get service log templates

path Parameters

required	string or string
name required	string Service name

query Parameters

container

string

Container name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

null

Store log templates

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
	string or string User-Agent header
Api-Version	string API version

Request Body schema: application/json
required

A JSON array of the log templates to be stored

One of

Array

tokens required	Array of strings
identifier required	integer <int64>
name required	string
hitCounter required	integer <int64>
container required	string
service required	string
namespace required	string

Responses

Request samples

Payload

Content type

application/json

null

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get service media

Returns list of media for a service

path Parameters

name required	string Service name
required	string or string Service namespace

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

null

Create new media for a service

path Parameters

name required	string Service name
required	string or string Service namespace

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Request Body schema: application/json
required

id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Remove media

Removes media with the specified UUID

path Parameters

id required	string <uuid> Media UUID
name required	string Service name
required	string or string Service namespace

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get service metrics

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

null

Get service pods

Returns list of pods for a service with basic information

path Parameters

required	string or string
name required	string Service name

query Parameters

boolean or boolean

If set to true, returns only deleted pods, false returns non-deleted, or all when not set

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

null

Create or update a pod and its containers

path Parameters

required	string or string
name required	string Service name

header Parameters

X-Scope-OrgID	string Tenant header
	string or string User-Agent header
Api-Version	string API version

Request Body schema: application/json
required

name required	string
namespace required	string
required	object (K8sConfiguration)
ownerService required	string
ownerNode required	string
phase required	string (K8sPod.Phase) Enum: "PENDING" "RUNNING" "SUCCEEDED" "FAILED" "UNKNOWN"
required	Array of objects (K8sContainerState)
ipAddresses required	Array of strings
statusChangeTime required	string <date-time>
createdAt required	string <date-time>
restartedLast required	string <date-time>
lastSeen	string <date-time>
deleted	boolean
	object (K8sResources)
required	Array of objects (K8sContainer)
edge required	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"namespace": "string",
"configuration": {"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"ownerService": "string",
"ownerNode": "string",
"phase": "PENDING",
"containerStates": [{"name": "string",
"ready": true,
"started": true,
"startedAt": 0,
"restartCount": 0,
"terminated": {"reason": "string",
"exitCode": 0
}
}
],
"ipAddresses": ["string"
],
"statusChangeTime": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"restartedLast": "2019-08-24T14:15:22Z",
"lastSeen": "2019-08-24T14:15:22Z",
"deleted": true,
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"containers": [{"namespace": "string",
"name": "string",
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"configuration": {"args": ["string"
],
"environment": [{ }
],
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"ownerService": "string",
"type": "REGULAR",
"lastSeen": "2019-08-24T14:15:22Z"
}
],
"edge": true
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

updateStatus

path Parameters

name required	string
namespace required	string

header Parameters

Api-Version

string

API version

Request Body schema: application/json
required

One of

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

null

Get container details

path Parameters

required	string or string
required	string or string Service name
name required	string Container name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"namespace": "string",
"name": "string",
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"configuration": {"args": ["string"
],
"environment": [{ }
],
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"ownerService": "string",
"type": "REGULAR",
"lastSeen": "2019-08-24T14:15:22Z"
}

Get service metric details

path Parameters

required	string or string
required	string or string Service name
required	string or string Metric name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
500

Content type

application/json

{"name": "string",
"type": "GAUGE",
"category": "string",
"main": true,
"lastSeen": "2019-08-24T14:15:22Z",
"serviceNameLabel": "string"
}

Get pod details

path Parameters

required	string or string
required	string or string Service name
name required	string Pod name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"name": "string",
"namespace": "string",
"configuration": {"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"ownerService": "string",
"ownerNode": "string",
"phase": "PENDING",
"containerStates": [{"name": "string",
"ready": true,
"started": true,
"startedAt": 0,
"restartCount": 0,
"terminated": {"reason": "string",
"exitCode": 0
}
}
],
"ipAddresses": ["string"
],
"status": "HEALTHY",
"statusChecks": [{"description": "string",
"checks": [{"result": "PASSED",
"details": "string"
}
],
"status": "HEALTHY",
"passedCount": 0,
"totalCount": 0
}
],
"statusChangeTime": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"restartedLast": "2019-08-24T14:15:22Z",
"lastSeen": "2019-08-24T14:15:22Z",
"deleted": true,
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"restarts": 0
}

Remove a pod

Removes a pod leaving other resources intact

path Parameters

required	string or string
required	string or string Service name
name required	string Pod name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

volumes

Get persistent volumes

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

null

Create or update a persistent volume

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Request Body schema: application/json
required

JSON representation of the persistent volume to be created/updated

name required	string
capacity required	string
storageClass required	string
accessModes required	Array of strings (K8sPersistentVolume.AccessMode) Items Enum: "ReadWriteOnce" "ReadOnlyMany" "ReadWriteMany" "ReadWriteOncePod"
reclaimPolicy required	string (K8sPersistentVolume.ReclaimPolicy) Enum: "RETAIN" "RECYCLE" "DELETE"
k8sStatus required	string (K8sPersistentVolume.Status) Enum: "AVAILABLE" "BOUND" "RELEASED" "FAILED"
mode required	string (K8sPersistentVolume.VolumeMode) Enum: "FILESYSTEM" "BLOCK"
required	object (K8sConfiguration)
reason required	string
message required	string
statusChangeTime required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"capacity": "string",
"storageClass": "string",
"accessModes": ["ReadWriteOnce"
],
"reclaimPolicy": "RETAIN",
"k8sStatus": "AVAILABLE",
"mode": "FILESYSTEM",
"configuration": {"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"reason": "string",
"message": "string",
"statusChangeTime": "2019-08-24T14:15:22Z"
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Get persistent volume claims

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

null

Create or update a persistent volume claim

header Parameters

X-Scope-OrgID	string Tenant header
	string or string User-Agent header
Api-Version	string API version

Request Body schema: application/json
required

JSON representation of the persistent volume claim to be created/updated

namespace required	string
name required	string
capacity required	string
storageClass required	string
accessModes required	Array of strings (K8sPersistentVolume.AccessMode) Items Enum: "ReadWriteOnce" "ReadOnlyMany" "ReadWriteMany" "ReadWriteOncePod"
k8sStatus required	string (K8sPersistentVolume.Status) Enum: "AVAILABLE" "BOUND" "RELEASED" "FAILED"
mode required	string (K8sPersistentVolume.VolumeMode) Enum: "FILESYSTEM" "BLOCK"
pvName required	string
conditions required	Array of strings
required	object (K8sConfiguration)
ownerServices required	Array of strings
statusChangeTime required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"namespace": "string",
"name": "string",
"capacity": "string",
"storageClass": "string",
"accessModes": ["ReadWriteOnce"
],
"k8sStatus": "AVAILABLE",
"mode": "FILESYSTEM",
"pvName": "string",
"conditions": ["string"
],
"configuration": {"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"conditions": [{"type": "string",
"status": "True",
"reason": "string"
}
]
},
"ownerServices": ["string"
],
"statusChangeTime": "2019-08-24T14:15:22Z"
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Remove a persistent volume

Removes a persistent volume

path Parameters

required	string or string
name required	string Persistent volume claim name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Remove a persistent volume

Removes a persistent volume

path Parameters

required

string or string

Persistent volume name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Topology service (v1)

topology

Get topology

header Parameters

Responses

Response samples

Cleanup old topology data

header Parameters

Responses

Response samples

Trigger background topology update operation

query Parameters

header Parameters

Responses

Response samples

addresses

Get addresses

header Parameters

Responses

Response samples

Create or update an address mapping

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove an address

path Parameters

header Parameters

Responses

Response samples

health

Get grouped health statuses divided for resource type

query Parameters

header Parameters

Responses

Response samples

log templates

Get log templates

query Parameters

header Parameters

Responses

Response samples

nodes

Get nodes

query Parameters

header Parameters

Responses

Response samples

Create or update a node

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get node details

path Parameters

header Parameters

Responses

Response samples

Remove a node

path Parameters

header Parameters

Responses

Response samples

Get node pods

path Parameters

header Parameters

Responses

Response samples

pods

Get pods

query Parameters

header Parameters

Responses

Response samples

services

Get services

query Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required