Blueprints

List Blueprints

get

Responses

200

OK

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/blueprints

HTTPcURLJavaScriptPython

GET /v1/blueprints HTTP/1.1
Accept: */*

{
  "blueprints": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "dateModified": "text",
        "deprecated": true,
        "description": "string",
        "displayName": "string",
        "hash": "text",
        "icon": "string",
        "id": "string",
        "labels": {},
        "name": "string",
        "resourceDocLink": "string",
        "stability": "string",
        "version": 1,
        "warning": "string"
      },
      "spec": {
        "disabled": true,
        "licenseEnabled": true,
        "parameters": [
          {
            "credential": true,
            "name": "text",
            "sensitive": true,
            "value": null
          }
        ],
        "presetTarget": {
          "type": "text",
          "versionConstraint": "text"
        },
        "processors": [
          {
            "description": "text",
            "disabled": true,
            "displayName": "text",
            "id": "text",
            "licenseEnabled": true,
            "name": "text",
            "parameters": [
              {
                "credential": true,
                "name": "text",
                "sensitive": true,
                "value": null
              }
            ],
            "presetTarget": {
              "type": "text",
              "versionConstraint": "text"
            },
            "processors": "[Circular Reference]",
            "public": true,
            "recommendation": "text",
            "routes": {
              "logs": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "logs+metrics": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "logs+metrics+traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "logs+traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "metrics": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "metrics+traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ]
            },
            "secOpsPipelineName": "text",
            "telemetryExample": {
              "after": {
                "attributes": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "body": null,
                "observedTimestamp": "text",
                "resource": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "severityNumber": 1,
                "severityText": "text",
                "timestamp": "text"
              },
              "before": {
                "attributes": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "body": null,
                "observedTimestamp": "text",
                "resource": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "severityNumber": 1,
                "severityText": "text",
                "timestamp": "text"
              },
              "telemetryType": "text"
            },
            "type": "text",
            "version": "text"
          }
        ],
        "public": true,
        "recommendation": "text",
        "telemetryExample": {
          "after": {
            "attributes": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "body": null,
            "observedTimestamp": "text",
            "resource": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "severityNumber": 1,
            "severityText": "text",
            "timestamp": "text"
          },
          "before": {
            "attributes": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "body": null,
            "observedTimestamp": "text",
            "resource": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "severityNumber": 1,
            "severityText": "text",
            "timestamp": "text"
          },
          "telemetryType": "text"
        },
        "type": "text",
        "version": "text"
      },
      "status": {
        "latest": true
      }
    }
  ]
}

Get Blueprint by name

get

Path parameters

namestringRequired

the name of the Blueprint

Responses

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/blueprints/{name}

HTTPcURLJavaScriptPython

GET /v1/blueprints/{name} HTTP/1.1
Accept: */*

{
  "blueprint": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "disabled": true,
      "licenseEnabled": true,
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "presetTarget": {
        "type": "text",
        "versionConstraint": "text"
      },
      "processors": [
        {
          "description": "text",
          "disabled": true,
          "displayName": "text",
          "id": "text",
          "licenseEnabled": true,
          "name": "text",
          "parameters": [
            {
              "credential": true,
              "name": "text",
              "sensitive": true,
              "value": null
            }
          ],
          "presetTarget": {
            "type": "text",
            "versionConstraint": "text"
          },
          "processors": [
            "[Circular Reference]"
          ],
          "public": true,
          "recommendation": "text",
          "routes": {
            "logs": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "telemetryExample": {
            "after": {
              "attributes": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "body": null,
              "observedTimestamp": "text",
              "resource": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "severityNumber": 1,
              "severityText": "text",
              "timestamp": "text"
            },
            "before": {
              "attributes": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "body": null,
              "observedTimestamp": "text",
              "resource": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "severityNumber": 1,
              "severityText": "text",
              "timestamp": "text"
            },
            "telemetryType": "text"
          },
          "type": "text",
          "version": "text"
        }
      ],
      "public": true,
      "recommendation": "text",
      "telemetryExample": {
        "after": {
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "body": null,
          "observedTimestamp": "text",
          "resource": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "severityNumber": 1,
          "severityText": "text",
          "timestamp": "text"
        },
        "before": {
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "body": null,
          "observedTimestamp": "text",
          "resource": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "severityNumber": 1,
          "severityText": "text",
          "timestamp": "text"
        },
        "telemetryType": "text"
      },
      "type": "text",
      "version": "text"
    },
    "status": {
      "latest": true
    }
  }
}