Get a resource definition.

Get a resource definition.

Get a resource definition.

Path Parameters

resourcedefinition string required

Responses

• 200
• 400
• 401
• 403
• 404
• 408
• 409
• 415
• 422
• 429
• 500
• 503
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

builtin boolean
createTime date-time
description string
id string
labels object
property name* string
matchingRules object[]
Array [
attributes object
property name* byte
createTime date-time
id string
name string
selector object
environmentLabels object
property name* string
environmentNames string[]
environmentTypes string[]
projectLabels object
property name* string
projectNames string[]
resourceLabels object
property name* string
template object
createTime date-time
id string
name string
project object
createTime date-time
description string
id string
labels object
property name* string
name string
updateTime date-time
schema object
object required
openAPISchema object required
components object
callbacks object
examples object
headers object
links object
parameters object
requestBodies object
responses object
schemas object
securitySchemes object
externalDocs object
description string
url string
info object required
contact object
email string
name string
url string
description string
license object
name string required
url string
termsOfService string
title string required
version string required
openapi string required
security object[]
servers object[]
Array [
description string
url string required
variables object
property name* object
default string
description string
enum string[]
]
tags object[]
Array [
description string
externalDocs object
description string
url string
name string
]
readme string required
requiredProviders object[] required
Array [
name string required
]
source string
template object
catalog object
createTime date-time
description string
filterPattern string
id string
labels object
property name* string
name string
project object
createTime date-time
description string
id string
labels object
property name* string
name string
updateTime date-time
source string
status object
conditions object[]
Array [
lastUpdateTime date-time
message string
reason string required
status string
type string
]
error boolean
inactive boolean
summaryStatus string
summaryStatusMessage string
transitioning boolean
warning boolean
sync object
failed integer required
succeeded integer required
time date-time required
total integer required
type string
updateTime date-time
createTime date-time
description string
icon string
id string
labels object
property name* string
name string
project object
createTime date-time
description string
id string
labels object
property name* string
name string
updateTime date-time
source string
status object
conditions object[]
Array [
lastUpdateTime date-time
message string
reason string required
status string
type string
]
error boolean
inactive boolean
summaryStatus string
summaryStatusMessage string
transitioning boolean
warning boolean
updateTime date-time
uiSchema object
openAPISchema object required
components object
callbacks object
examples object
headers object
links object
parameters object
requestBodies object
responses object
schemas object
securitySchemes object
externalDocs object
description string
url string
info object required
contact object
email string
name string
url string
description string
license object
name string required
url string
termsOfService string
title string required
version string required
openapi string required
security object[]
servers object[]
Array [
description string
url string required
variables object
property name* object
default string
description string
enum string[]
]
tags object[]
Array [
description string
externalDocs object
description string
url string
name string
]
updateTime date-time
version string
]
name string
schema object
openAPISchema object required
components object
callbacks object
examples object
headers object
links object
parameters object
requestBodies object
responses object
schemas object
securitySchemes object
externalDocs object
description string
url string
info object required
contact object
email string
name string
url string
description string
license object
name string required
url string
termsOfService string
title string required
version string required
openapi string required
security object[]
servers object[]
Array [
description string
url string required
variables object
property name* object
default string
description string
enum string[]
]
tags object[]
Array [
description string
externalDocs object
description string
url string
name string
]
type string
uiSchema object
openAPISchema object required
components object
callbacks object
examples object
headers object
links object
parameters object
requestBodies object
responses object
schemas object
securitySchemes object
externalDocs object
description string
url string
info object required
contact object
email string
name string
url string
description string
license object
name string required
url string
termsOfService string
title string required
version string required
openapi string required
security object[]
servers object[]
Array [
description string
url string required
variables object
property name* object
default string
description string
enum string[]
]
tags object[]
Array [
description string
externalDocs object
description string
url string
name string
]
updateTime date-time

{
  "builtin": true,
  "createTime": "2024-03-21T10:37:39.511Z",
  "description": "string",
  "id": "string",
  "labels": {},
  "matchingRules": [
    {
      "attributes": {},
      "createTime": "2024-03-21T10:37:39.511Z",
      "id": "string",
      "name": "string",
      "selector": {
        "environmentLabels": {},
        "environmentNames": [
          "string"
        ],
        "environmentTypes": [
          "string"
        ],
        "projectLabels": {},
        "projectNames": [
          "string"
        ],
        "resourceLabels": {}
      },
      "template": {
        "createTime": "2024-03-21T10:37:39.512Z",
        "id": "string",
        "name": "string",
        "project": {
          "createTime": "2024-03-21T10:37:39.512Z",
          "description": "string",
          "id": "string",
          "labels": {},
          "name": "string",
          "updateTime": "2024-03-21T10:37:39.512Z"
        },
        "schema": {
          "": {
            "openAPISchema": {
              "components": {
                "callbacks": {},
                "examples": {},
                "headers": {},
                "links": {},
                "parameters": {},
                "requestBodies": {},
                "responses": {},
                "schemas": {},
                "securitySchemes": {}
              },
              "externalDocs": {
                "description": "string",
                "url": "string"
              },
              "info": {
                "contact": {
                  "email": "string",
                  "name": "string",
                  "url": "string"
                },
                "description": "string",
                "license": {
                  "name": "string",
                  "url": "string"
                },
                "termsOfService": "string",
                "title": "string",
                "version": "string"
              },
              "openapi": "string",
              "security": [
                {}
              ],
              "servers": [
                {
                  "description": "string",
                  "url": "string",
                  "variables": {}
                }
              ],
              "tags": [
                {
                  "description": "string",
                  "externalDocs": {
                    "description": "string",
                    "url": "string"
                  },
                  "name": "string"
                }
              ]
            }
          },
          "readme": "string",
          "requiredProviders": [
            {
              "name": "string"
            }
          ]
        },
        "source": "string",
        "template": {
          "catalog": {
            "createTime": "2024-03-21T10:37:39.512Z",
            "description": "string",
            "filterPattern": "string",
            "id": "string",
            "labels": {},
            "name": "string",
            "project": {
              "createTime": "2024-03-21T10:37:39.512Z",
              "description": "string",
              "id": "string",
              "labels": {},
              "name": "string",
              "updateTime": "2024-03-21T10:37:39.512Z"
            },
            "source": "string",
            "status": {
              "conditions": [
                {
                  "lastUpdateTime": "2024-03-21T10:37:39.512Z",
                  "message": "string",
                  "reason": "string",
                  "status": "string",
                  "type": "string"
                }
              ],
              "error": true,
              "inactive": true,
              "summaryStatus": "string",
              "summaryStatusMessage": "string",
              "transitioning": true,
              "warning": true
            },
            "sync": {
              "failed": 0,
              "succeeded": 0,
              "time": "2024-03-21T10:37:39.512Z",
              "total": 0
            },
            "type": "string",
            "updateTime": "2024-03-21T10:37:39.512Z"
          },
          "createTime": "2024-03-21T10:37:39.512Z",
          "description": "string",
          "icon": "string",
          "id": "string",
          "labels": {},
          "name": "string",
          "project": {
            "createTime": "2024-03-21T10:37:39.512Z",
            "description": "string",
            "id": "string",
            "labels": {},
            "name": "string",
            "updateTime": "2024-03-21T10:37:39.512Z"
          },
          "source": "string",
          "status": {
            "conditions": [
              {
                "lastUpdateTime": "2024-03-21T10:37:39.512Z",
                "message": "string",
                "reason": "string",
                "status": "string",
                "type": "string"
              }
            ],
            "error": true,
            "inactive": true,
            "summaryStatus": "string",
            "summaryStatusMessage": "string",
            "transitioning": true,
            "warning": true
          },
          "updateTime": "2024-03-21T10:37:39.512Z"
        },
        "uiSchema": {
          "openAPISchema": {
            "components": {
              "callbacks": {},
              "examples": {},
              "headers": {},
              "links": {},
              "parameters": {},
              "requestBodies": {},
              "responses": {},
              "schemas": {},
              "securitySchemes": {}
            },
            "externalDocs": {
              "description": "string",
              "url": "string"
            },
            "info": {
              "contact": {
                "email": "string",
                "name": "string",
                "url": "string"
              },
              "description": "string",
              "license": {
                "name": "string",
                "url": "string"
              },
              "termsOfService": "string",
              "title": "string",
              "version": "string"
            },
            "openapi": "string",
            "security": [
              {}
            ],
            "servers": [
              {
                "description": "string",
                "url": "string",
                "variables": {}
              }
            ],
            "tags": [
              {
                "description": "string",
                "externalDocs": {
                  "description": "string",
                  "url": "string"
                },
                "name": "string"
              }
            ]
          }
        },
        "updateTime": "2024-03-21T10:37:39.512Z",
        "version": "string"
      }
    }
  ],
  "name": "string",
  "schema": {
    "openAPISchema": {
      "components": {
        "callbacks": {},
        "examples": {},
        "headers": {},
        "links": {},
        "parameters": {},
        "requestBodies": {},
        "responses": {},
        "schemas": {},
        "securitySchemes": {}
      },
      "externalDocs": {
        "description": "string",
        "url": "string"
      },
      "info": {
        "contact": {
          "email": "string",
          "name": "string",
          "url": "string"
        },
        "description": "string",
        "license": {
          "name": "string",
          "url": "string"
        },
        "termsOfService": "string",
        "title": "string",
        "version": "string"
      },
      "openapi": "string",
      "security": [
        {}
      ],
      "servers": [
        {
          "description": "string",
          "url": "string",
          "variables": {}
        }
      ],
      "tags": [
        {
          "description": "string",
          "externalDocs": {
            "description": "string",
            "url": "string"
          },
          "name": "string"
        }
      ]
    }
  },
  "type": "string",
  "uiSchema": {
    "openAPISchema": {
      "components": {
        "callbacks": {},
        "examples": {},
        "headers": {},
        "links": {},
        "parameters": {},
        "requestBodies": {},
        "responses": {},
        "schemas": {},
        "securitySchemes": {}
      },
      "externalDocs": {
        "description": "string",
        "url": "string"
      },
      "info": {
        "contact": {
          "email": "string",
          "name": "string",
          "url": "string"
        },
        "description": "string",
        "license": {
          "name": "string",
          "url": "string"
        },
        "termsOfService": "string",
        "title": "string",
        "version": "string"
      },
      "openapi": "string",
      "security": [
        {}
      ],
      "servers": [
        {
          "description": "string",
          "url": "string",
          "variables": {}
        }
      ],
      "tags": [
        {
          "description": "string",
          "externalDocs": {
            "description": "string",
            "url": "string"
          },
          "name": "string"
        }
      ]
    }
  },
  "updateTime": "2024-03-21T10:37:39.512Z"
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 400

statusText string

Default value: Bad Request

{
  "message": "string",
  "status": 400,
  "statusText": "Bad Request"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 401

statusText string

Default value: Unauthorized

{
  "message": "string",
  "status": 401,
  "statusText": "Unauthorized"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 403

statusText string

Default value: Forbidden

{
  "message": "string",
  "status": 403,
  "statusText": "Forbidden"
}

Not Found

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 404

statusText string

Default value: Not Found

{
  "message": "string",
  "status": 404,
  "statusText": "Not Found"
}

Request Timeout

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 408

statusText string

Default value: Request Timeout

{
  "message": "string",
  "status": 408,
  "statusText": "Request Timeout"
}

Conflict

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 409

statusText string

Default value: Conflict

{
  "message": "string",
  "status": 409,
  "statusText": "Conflict"
}

Unsupported Media Type

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 415

statusText string

Default value: Unsupported Media Type

{
  "message": "string",
  "status": 415,
  "statusText": "Unsupported Media Type"
}

Unprocessable Entity

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 422

statusText string

Default value: Unprocessable Entity

{
  "message": "string",
  "status": 422,
  "statusText": "Unprocessable Entity"
}

Too Many Requests

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 429

statusText string

Default value: Too Many Requests

{
  "message": "string",
  "status": 429,
  "statusText": "Too Many Requests"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 500

statusText string

Default value: Internal Server Error

{
  "message": "string",
  "status": 500,
  "statusText": "Internal Server Error"
}

Service Unavailable

application/json

Schema

Example (from schema)

---

Schema

message string
status integer

Default value: 503

statusText string

Default value: Service Unavailable

{
  "message": "string",
  "status": 503,
  "statusText": "Service Unavailable"
}

Loading...