Recipe Resource Service List

Recipe Resource Service List

List Recipes.

Request
URI
GET
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/policy/types/{searchScope.typeName}/recipes
COPY
Path Parameters
string
searchScope.typeName
Required

Scope search to the specified type_name; supports globbing; default (*).

Query Parameters
string
searchScope.name
Optional

Scope search to the specified name; supports globbing; default (*).

string
sortBy
Optional

Sort Order.

string
query
Optional

TQL query string.

string
pagination.offset
Optional

Offset at which to start returning records.

string
pagination.size
Optional

Number of records to return.

boolean
includeTotalCount
Optional

Include total count.


Responses
200

A successful response.

{
    "recipes": [
        {
            "type": {
                "kind": "string",
                "version": "string",
                "package": "string"
            },
            "fullName": {
                "orgId": "string",
                "typeName": "string",
                "name": "string"
            },
            "meta": {
                "uid": "string",
                "generation": "string",
                "resourceVersion": "string",
                "creationTime": "string",
                "updateTime": "string",
                "description": "string",
                "parentReferences": [
                    {
                        "rid": "string",
                        "uid": "string"
                    }
                ]
            },
            "spec": {
                "inputSchema": "string",
                "policyTemplates": [
                    {
                        "rid": "string",
                        "uid": "string"
                    }
                ],
                "deprecated": false
            }
        }
    ],
    "totalCount": "string"
}

default

An unexpected error response.

Returns grpc.gateway.runtime.Error of type(s) */*
{
    "error": "string",
    "code": 0,
    "message": "string",
    "details": [
        {
            "typeUrl": "string",
            "value": "string"
        }
    ]
}