Rollouts

Get all rollouts

get

Returns the list of configurations whose rollouts can be inspected. The response payload is identical to GET /configurations; callers should inspect each configuration's status.rollout field to determine its current rollout state.

Responses

200

Configurations returned successfully

application/json

401

Authentication required

application/json

500

Internal server error while loading configurations

application/json

get/rollouts

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

{
  "configurations": [
    {
      "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": {
        "configurations": [
          "[Circular Reference]"
        ],
        "connectors": [
          "[Circular Reference]"
        ],
        "contentType": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "disableLegacyEnvVarNormalization": true,
        "extensions": [
          "[Circular Reference]"
        ],
        "measurementInterval": "text",
        "parameters": [
          {
            "credential": true,
            "name": "text",
            "sensitive": true,
            "value": null
          }
        ],
        "processors": [
          "[Circular Reference]"
        ],
        "raw": "text",
        "rollout": {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        },
        "selector": {
          "matchLabels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "sources": [
          "[Circular Reference]"
        ],
        "topologyInterval": "text",
        "type": "text"
      },
      "status": {
        "current": true,
        "currentVersion": -2,
        "latest": true,
        "pending": true,
        "pendingVersion": -2,
        "rollout": {
          "completedAt": "text",
          "name": "text",
          "options": {
            "maxErrors": 1,
            "phaseAgentCount": {
              "initial": 1,
              "maximum": 1,
              "multiplier": 1,
              "type": "adaptive"
            }
          },
          "phase": 1,
          "progress": {
            "completed": 1,
            "errors": 1,
            "incompatible": 1,
            "pending": 1,
            "waiting": 1
          },
          "stage": 1,
          "stages": [
            {
              "labels": {},
              "name": "text",
              "progress": {
                "completed": 1,
                "errors": 1,
                "incompatible": 1,
                "pending": 1,
                "waiting": 1
              },
              "startedAt": "text"
            }
          ],
          "startedAt": "text",
          "status": 0
        }
      }
    }
  ]
}

Update all active rollouts

post

Advances every active rollout by one evaluation cycle. Returns the configurations that were actually updated; configurations whose rollouts were stable or otherwise did not advance are omitted from the response.

Responses

202

Active rollouts advanced; updated configurations returned

application/json

401

Authentication required

application/json

500

Internal server error while updating rollouts

application/json

post/rollouts

POST /v1/rollouts HTTP/1.1
Accept: */*

{
  "configurations": [
    {
      "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": {
        "configurations": [
          "[Circular Reference]"
        ],
        "connectors": [
          "[Circular Reference]"
        ],
        "contentType": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "disableLegacyEnvVarNormalization": true,
        "extensions": [
          "[Circular Reference]"
        ],
        "measurementInterval": "text",
        "parameters": [
          {
            "credential": true,
            "name": "text",
            "sensitive": true,
            "value": null
          }
        ],
        "processors": [
          "[Circular Reference]"
        ],
        "raw": "text",
        "rollout": {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        },
        "selector": {
          "matchLabels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "sources": [
          "[Circular Reference]"
        ],
        "topologyInterval": "text",
        "type": "text"
      },
      "status": {
        "current": true,
        "currentVersion": -2,
        "latest": true,
        "pending": true,
        "pendingVersion": -2,
        "rollout": {
          "completedAt": "text",
          "name": "text",
          "options": {
            "maxErrors": 1,
            "phaseAgentCount": {
              "initial": 1,
              "maximum": 1,
              "multiplier": 1,
              "type": "adaptive"
            }
          },
          "phase": 1,
          "progress": {
            "completed": 1,
            "errors": 1,
            "incompatible": 1,
            "pending": 1,
            "waiting": 1
          },
          "stage": 1,
          "stages": [
            {
              "labels": {},
              "name": "text",
              "progress": {
                "completed": 1,
                "errors": 1,
                "incompatible": 1,
                "pending": 1,
                "waiting": 1
              },
              "startedAt": "text"
            }
          ],
          "startedAt": "text",
          "status": 0
        }
      }
    }
  ]
}

Get rollout configuration by name

get

Returns the configuration with the given name, including its current rollout state on status.rollout. Read-only; this endpoint does not advance the rollout.

Path parameters

namestringRequired

the name of the configuration

Responses

200

Configuration returned successfully

application/json

rawstringOptional

401

Authentication required

application/json

404

No configuration exists with the given name

application/json

500

Internal server error while loading the configuration

application/json

get/rollouts/{name}

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

{
  "configuration": {
    "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": {
      "configurations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "connectors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "contentType": "text",
      "destinations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "disableLegacyEnvVarNormalization": true,
      "extensions": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "measurementInterval": "text",
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "processors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "raw": "text",
      "rollout": {
        "connectors": [
          "[Circular Reference]"
        ],
        "description": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "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": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ]
        },
        "secOpsPipelineName": "text",
        "sources": [
          "[Circular Reference]"
        ],
        "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"
      },
      "selector": {
        "matchLabels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "sources": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "topologyInterval": "text",
      "type": "text"
    },
    "status": {
      "current": true,
      "currentVersion": -2,
      "latest": true,
      "pending": true,
      "pendingVersion": -2,
      "rollout": {
        "completedAt": "text",
        "name": "text",
        "options": {
          "maxErrors": 1,
          "phaseAgentCount": {
            "initial": 1,
            "maximum": 1,
            "multiplier": 1,
            "type": "adaptive"
          }
        },
        "phase": 1,
        "progress": {
          "completed": 1,
          "errors": 1,
          "incompatible": 1,
          "pending": 1,
          "waiting": 1
        },
        "stage": 1,
        "stages": [
          {
            "labels": {},
            "name": "text",
            "progress": {
              "completed": 1,
              "errors": 1,
              "incompatible": 1,
              "pending": 1,
              "waiting": 1
            },
            "startedAt": "text"
          }
        ],
        "startedAt": "text",
        "status": 0
      }
    }
  },
  "raw": "text"
}

Pause rollout by configuration name

put

Pauses an in-progress rollout for the named configuration. If the rollout is not in the started state (e.g. it is already paused, stable, or errored), this is a no-op and the current configuration is returned unchanged. A 202 response therefore indicates the request was accepted, not that a state transition necessarily occurred — inspect status.rollout.status on the returned configuration to confirm the rollout is paused.

Path parameters

namestringRequired

the name of the configuration

Responses

202

Pause accepted; rollout paused or already not in a started state (no-op)

application/json

rawstringOptional

401

Authentication required

application/json

404

No configuration exists with the given name

application/json

500

Internal server error while pausing the rollout

application/json

put/rollouts/{name}/pause

PUT /v1/rollouts/{name}/pause HTTP/1.1
Accept: */*

{
  "configuration": {
    "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": {
      "configurations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "connectors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "contentType": "text",
      "destinations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "disableLegacyEnvVarNormalization": true,
      "extensions": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "measurementInterval": "text",
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "processors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "raw": "text",
      "rollout": {
        "connectors": [
          "[Circular Reference]"
        ],
        "description": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "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": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ]
        },
        "secOpsPipelineName": "text",
        "sources": [
          "[Circular Reference]"
        ],
        "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"
      },
      "selector": {
        "matchLabels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "sources": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "topologyInterval": "text",
      "type": "text"
    },
    "status": {
      "current": true,
      "currentVersion": -2,
      "latest": true,
      "pending": true,
      "pendingVersion": -2,
      "rollout": {
        "completedAt": "text",
        "name": "text",
        "options": {
          "maxErrors": 1,
          "phaseAgentCount": {
            "initial": 1,
            "maximum": 1,
            "multiplier": 1,
            "type": "adaptive"
          }
        },
        "phase": 1,
        "progress": {
          "completed": 1,
          "errors": 1,
          "incompatible": 1,
          "pending": 1,
          "waiting": 1
        },
        "stage": 1,
        "stages": [
          {
            "labels": {},
            "name": "text",
            "progress": {
              "completed": 1,
              "errors": 1,
              "incompatible": 1,
              "pending": 1,
              "waiting": 1
            },
            "startedAt": "text"
          }
        ],
        "startedAt": "text",
        "status": 0
      }
    }
  },
  "raw": "text"
}

Resume rollout by configuration name

put

Resumes a paused or errored rollout for the named configuration. If the rollout is in an error state, the max-errors budget is increased so the rollout can progress past the failed agents. If the rollout is in any other state (e.g. stable, replace pending), this is a no-op and the current configuration is returned unchanged.

Path parameters

namestringRequired

the name of the configuration

Responses

202

Rollout resumed, or no-op if the rollout was not paused or errored

application/json

rawstringOptional

401

Authentication required

application/json

404

No configuration exists with the given name

application/json

500

Internal server error while resuming the rollout

application/json

put/rollouts/{name}/resume

PUT /v1/rollouts/{name}/resume HTTP/1.1
Accept: */*

{
  "configuration": {
    "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": {
      "configurations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "connectors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "contentType": "text",
      "destinations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "disableLegacyEnvVarNormalization": true,
      "extensions": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "measurementInterval": "text",
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "processors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "raw": "text",
      "rollout": {
        "connectors": [
          "[Circular Reference]"
        ],
        "description": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "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": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ]
        },
        "secOpsPipelineName": "text",
        "sources": [
          "[Circular Reference]"
        ],
        "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"
      },
      "selector": {
        "matchLabels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "sources": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "topologyInterval": "text",
      "type": "text"
    },
    "status": {
      "current": true,
      "currentVersion": -2,
      "latest": true,
      "pending": true,
      "pendingVersion": -2,
      "rollout": {
        "completedAt": "text",
        "name": "text",
        "options": {
          "maxErrors": 1,
          "phaseAgentCount": {
            "initial": 1,
            "maximum": 1,
            "multiplier": 1,
            "type": "adaptive"
          }
        },
        "phase": 1,
        "progress": {
          "completed": 1,
          "errors": 1,
          "incompatible": 1,
          "pending": 1,
          "waiting": 1
        },
        "stage": 1,
        "stages": [
          {
            "labels": {},
            "name": "text",
            "progress": {
              "completed": 1,
              "errors": 1,
              "incompatible": 1,
              "pending": 1,
              "waiting": 1
            },
            "startedAt": "text"
          }
        ],
        "startedAt": "text",
        "status": 0
      }
    }
  },
  "raw": "text"
}

Start rollout by configuration name

post

Starts a rollout for the named configuration. Behavior depends on the current rollout state: if the rollout is already started or stable, this is a no-op and the current configuration is returned. If the rollout is paused, it is resumed. Otherwise a new rollout is created from the configuration's rollout spec. The optional request body overrides the default phase options (rollout size, max errors, etc.) computed from the agent count.

Path parameters

namestringRequired

the name of the configuration

Body

maxErrorsintegerOptional

MaxErrors is the maximum number of failed agents before the rollout will be considered an error

Responses

202

Rollout started, resumed, or already in a started/stable state

application/json

rawstringOptional

400

Invalid options payload, or the configuration references unlicensed components

application/json

401

Authentication required

application/json

404

No configuration exists with the given name

application/json

500

Internal server error while starting the rollout

application/json

post/rollouts/{name}/start

POST /v1/rollouts/{name}/start HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "maxErrors": 1,
  "phaseAgentCount": {
    "initial": 1,
    "maximum": 1,
    "multiplier": 1,
    "type": "adaptive"
  }
}

{
  "configuration": {
    "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": {
      "configurations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "connectors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "contentType": "text",
      "destinations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "disableLegacyEnvVarNormalization": true,
      "extensions": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "measurementInterval": "text",
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "processors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "raw": "text",
      "rollout": {
        "connectors": [
          "[Circular Reference]"
        ],
        "description": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "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": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ]
        },
        "secOpsPipelineName": "text",
        "sources": [
          "[Circular Reference]"
        ],
        "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"
      },
      "selector": {
        "matchLabels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "sources": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "topologyInterval": "text",
      "type": "text"
    },
    "status": {
      "current": true,
      "currentVersion": -2,
      "latest": true,
      "pending": true,
      "pendingVersion": -2,
      "rollout": {
        "completedAt": "text",
        "name": "text",
        "options": {
          "maxErrors": 1,
          "phaseAgentCount": {
            "initial": 1,
            "maximum": 1,
            "multiplier": 1,
            "type": "adaptive"
          }
        },
        "phase": 1,
        "progress": {
          "completed": 1,
          "errors": 1,
          "incompatible": 1,
          "pending": 1,
          "waiting": 1
        },
        "stage": 1,
        "stages": [
          {
            "labels": {},
            "name": "text",
            "progress": {
              "completed": 1,
              "errors": 1,
              "incompatible": 1,
              "pending": 1,
              "waiting": 1
            },
            "startedAt": "text"
          }
        ],
        "startedAt": "text",
        "status": 0
      }
    }
  },
  "raw": "text"
}

Status of configuration rollout by name

get

Returns the configuration with the given name so the caller can inspect its current rollout status on status.rollout. Read-only; the rollout is not advanced. Responds with 202 Accepted for parity with the write endpoints (start/pause/resume) so polling clients can treat all rollout transition responses uniformly.

Path parameters

namestringRequired

the name of the configuration

Responses

202

Current rollout status returned

application/json

rawstringOptional

401

Authentication required

application/json

404

No configuration exists with the given name

application/json

500

Internal server error while loading the configuration

application/json

get/rollouts/{name}/status

GET /v1/rollouts/{name}/status HTTP/1.1
Accept: */*

{
  "configuration": {
    "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": {
      "configurations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "connectors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "contentType": "text",
      "destinations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "disableLegacyEnvVarNormalization": true,
      "extensions": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "measurementInterval": "text",
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "processors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "raw": "text",
      "rollout": {
        "connectors": [
          "[Circular Reference]"
        ],
        "description": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "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": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ]
        },
        "secOpsPipelineName": "text",
        "sources": [
          "[Circular Reference]"
        ],
        "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"
      },
      "selector": {
        "matchLabels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "sources": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "topologyInterval": "text",
      "type": "text"
    },
    "status": {
      "current": true,
      "currentVersion": -2,
      "latest": true,
      "pending": true,
      "pendingVersion": -2,
      "rollout": {
        "completedAt": "text",
        "name": "text",
        "options": {
          "maxErrors": 1,
          "phaseAgentCount": {
            "initial": 1,
            "maximum": 1,
            "multiplier": 1,
            "type": "adaptive"
          }
        },
        "phase": 1,
        "progress": {
          "completed": 1,
          "errors": 1,
          "incompatible": 1,
          "pending": 1,
          "waiting": 1
        },
        "stage": 1,
        "stages": [
          {
            "labels": {},
            "name": "text",
            "progress": {
              "completed": 1,
              "errors": 1,
              "incompatible": 1,
              "pending": 1,
              "waiting": 1
            },
            "startedAt": "text"
          }
        ],
        "startedAt": "text",
        "status": 0
      }
    }
  },
  "raw": "text"
}

Update rollout by configuration name

post

Re-evaluates the rollout for the named configuration against current agent progress. If new agents can be moved to pending or the rollout phase has completed, the rollout advances. If the rollout is paused, stable, or otherwise has no progress to apply, the current configuration is returned unchanged. Use this to drive forward a rollout that does not auto-advance, or after manually resolving rollout errors.

Path parameters

namestringRequired

the name of the configuration

Responses

200

Rollout evaluated; current configuration returned

application/json

rawstringOptional

401

Authentication required

application/json

404

No configuration exists with the given name

application/json

500

Internal server error while updating the rollout

application/json

post/rollouts/{name}/update

POST /v1/rollouts/{name}/update HTTP/1.1
Accept: */*

{
  "configuration": {
    "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": {
      "configurations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "connectors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "contentType": "text",
      "destinations": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "disableLegacyEnvVarNormalization": true,
      "extensions": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "measurementInterval": "text",
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "processors": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "raw": "text",
      "rollout": {
        "connectors": [
          "[Circular Reference]"
        ],
        "description": "text",
        "destinations": [
          "[Circular Reference]"
        ],
        "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": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "logs+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "metrics+traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ],
          "traces": [
            {
              "components": [
                "exit"
              ],
              "id": "text"
            }
          ]
        },
        "secOpsPipelineName": "text",
        "sources": [
          "[Circular Reference]"
        ],
        "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"
      },
      "selector": {
        "matchLabels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "sources": [
        {
          "connectors": "[Circular Reference]",
          "description": "text",
          "destinations": "[Circular Reference]",
          "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": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "exit"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "sources": "[Circular Reference]",
          "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"
        }
      ],
      "topologyInterval": "text",
      "type": "text"
    },
    "status": {
      "current": true,
      "currentVersion": -2,
      "latest": true,
      "pending": true,
      "pendingVersion": -2,
      "rollout": {
        "completedAt": "text",
        "name": "text",
        "options": {
          "maxErrors": 1,
          "phaseAgentCount": {
            "initial": 1,
            "maximum": 1,
            "multiplier": 1,
            "type": "adaptive"
          }
        },
        "phase": 1,
        "progress": {
          "completed": 1,
          "errors": 1,
          "incompatible": 1,
          "pending": 1,
          "waiting": 1
        },
        "stage": 1,
        "stages": [
          {
            "labels": {},
            "name": "text",
            "progress": {
              "completed": 1,
              "errors": 1,
              "incompatible": 1,
              "pending": 1,
              "waiting": 1
            },
            "startedAt": "text"
          }
        ],
        "startedAt": "text",
        "status": 0
      }
    }
  },
  "raw": "text"
}