Skip to content

List

PUT
/api/web/namespaces/system/catalogs
curl --request PUT \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/system/catalogs \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "use_case_filter": "example", "workspace_filter": "example" }'

Retrieves service catalog tailor for the currently logged-in user.

Examples of this operation.

Media typeapplication/json
ListRequest

List request message. Includes optional filter.

object
use_case_filter
Use case filter

Exclusive with [workspace_filter] Filter by use case name. If empty, all use cases are returned.

string
<= 1024 characters
workspace_filter
Workspace Filter

Exclusive with [use_case_filter] Filter by workspace name. If empty, all workspaces are returned. The use case response field will contain the use case of the workspace and no other use cases.

string
<= 1024 characters
Examplegenerated
{
"use_case_filter": "example",
"workspace_filter": "example"
}

A successful response.

Media typeapplication/json
ListResponse

Response message for list request.

object
addon_services
Addon Services

List of Addon Services. The key is the addon service name.

object
services
Services

List of result services (addons). The key is the service name.

object
system_management
System Management

List of system management tiles. The key is the workspace name.

object
use_cases
Use Cases

List of result use cases. The key is the use case name.

object
workspaces
Workspaces

List of result tiles (workspaces). The key is the workspace name.

object
Examplegenerated
{
"addon_services": {},
"services": {},
"system_management": {},
"use_cases": {},
"workspaces": {}
}

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