> For the complete documentation index, see [llms.txt](https://docs.bindplane.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bindplane.com/cli-and-api/api/rollouts.md).

# Rollouts

## Get all rollouts

> 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.

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts":{"get":{"description":"Returns the list of configurations whose rollouts can be inspected. The response payload\nis identical to GET /configurations; callers should inspect each configuration's\nstatus.rollout field to determine its current rollout state.","tags":["rollouts"],"summary":"Get all rollouts","responses":{"200":{"description":"Configurations returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationsResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while loading configurations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}}}}},"components":{"schemas":{"model.ConfigurationsResponse":{"type":"object","properties":{"configurations":{"type":"array","items":{"$ref":"#/components/schemas/model.Configuration"}}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## Update all active rollouts

> 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.

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts":{"post":{"description":"Advances every active rollout by one evaluation cycle. Returns the configurations\nthat were actually updated; configurations whose rollouts were stable or otherwise\ndid not advance are omitted from the response.","tags":["rollouts"],"summary":"Update all active rollouts","responses":{"202":{"description":"Active rollouts advanced; updated configurations returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationsResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while updating rollouts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}}}}},"components":{"schemas":{"model.ConfigurationsResponse":{"type":"object","properties":{"configurations":{"type":"array","items":{"$ref":"#/components/schemas/model.Configuration"}}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## Get rollout configuration by name

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

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts/{name}":{"get":{"description":"Returns the configuration with the given name, including its current rollout state on\nstatus.rollout. Read-only; this endpoint does not advance the rollout.","tags":["rollouts"],"summary":"Get rollout configuration by name","parameters":[{"schema":{"type":"string"},"description":"the name of the configuration","name":"name","in":"path","required":true}],"responses":{"200":{"description":"Configuration returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"404":{"description":"No configuration exists with the given name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while loading the configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}}}}},"components":{"schemas":{"model.ConfigurationResponse":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/model.Configuration"},"raw":{"type":"string"}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## Pause rollout by configuration name

> 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.

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts/{name}/pause":{"put":{"description":"Pauses an in-progress rollout for the named configuration. If the rollout is not in the\nstarted state (e.g. it is already paused, stable, or errored), this is a no-op and the\ncurrent configuration is returned unchanged. A 202 response therefore indicates the\nrequest was accepted, not that a state transition necessarily occurred — inspect\nstatus.rollout.status on the returned configuration to confirm the rollout is paused.","tags":["rollouts"],"summary":"Pause rollout by configuration name","parameters":[{"schema":{"type":"string"},"description":"the name of the configuration","name":"name","in":"path","required":true}],"responses":{"202":{"description":"Pause accepted; rollout paused or already not in a started state (no-op)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"404":{"description":"No configuration exists with the given name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while pausing the rollout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}}}}},"components":{"schemas":{"model.ConfigurationResponse":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/model.Configuration"},"raw":{"type":"string"}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## Resume rollout by configuration name

> 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.

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts/{name}/resume":{"put":{"description":"Resumes a paused or errored rollout for the named configuration. If the rollout is in\nan error state, the max-errors budget is increased so the rollout can progress past the\nfailed agents. If the rollout is in any other state (e.g. stable, replace pending), this\nis a no-op and the current configuration is returned unchanged.","tags":["rollouts"],"summary":"Resume rollout by configuration name","parameters":[{"schema":{"type":"string"},"description":"the name of the configuration","name":"name","in":"path","required":true}],"responses":{"202":{"description":"Rollout resumed, or no-op if the rollout was not paused or errored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"404":{"description":"No configuration exists with the given name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while resuming the rollout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}}}}},"components":{"schemas":{"model.ConfigurationResponse":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/model.Configuration"},"raw":{"type":"string"}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## Start rollout by configuration name

> 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.

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts/{name}/start":{"post":{"description":"Starts a rollout for the named configuration. Behavior depends on the current rollout state:\nif the rollout is already started or stable, this is a no-op and the current configuration\nis returned. If the rollout is paused, it is resumed. Otherwise a new rollout is created\nfrom the configuration's rollout spec. The optional request body overrides the default\nphase options (rollout size, max errors, etc.) computed from the agent count.","tags":["rollouts"],"summary":"Start rollout by configuration name","parameters":[{"schema":{"type":"string"},"description":"the name of the configuration","name":"name","in":"path","required":true}],"responses":{"202":{"description":"Rollout started, resumed, or already in a started/stable state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationResponse"}}}},"400":{"description":"Invalid options payload, or the configuration references unlicensed components","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"404":{"description":"No configuration exists with the given name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while starting the rollout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.RolloutOptions"}}},"description":"the options for the rollout"}}}},"components":{"schemas":{"model.ConfigurationResponse":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/model.Configuration"},"raw":{"type":"string"}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## Status of configuration rollout by name

> 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.

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts/{name}/status":{"get":{"description":"Returns the configuration with the given name so the caller can inspect its current\nrollout status on status.rollout. Read-only; the rollout is not advanced. Responds with\n202 Accepted for parity with the write endpoints (start/pause/resume) so polling clients\ncan treat all rollout transition responses uniformly.","tags":["rollouts"],"summary":"Status of configuration rollout by name","parameters":[{"schema":{"type":"string"},"description":"the name of the configuration","name":"name","in":"path","required":true}],"responses":{"202":{"description":"Current rollout status returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"404":{"description":"No configuration exists with the given name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while loading the configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}}}}},"components":{"schemas":{"model.ConfigurationResponse":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/model.Configuration"},"raw":{"type":"string"}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```

## Update rollout by configuration name

> 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.

```json
{"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"servers":[{"url":"/v1"}],"paths":{"/rollouts/{name}/update":{"post":{"description":"Re-evaluates the rollout for the named configuration against current agent progress.\nIf new agents can be moved to pending or the rollout phase has completed, the rollout\nadvances. If the rollout is paused, stable, or otherwise has no progress to apply, the\ncurrent configuration is returned unchanged. Use this to drive forward a rollout that\ndoes not auto-advance, or after manually resolving rollout errors.","tags":["rollouts"],"summary":"Update rollout by configuration name","parameters":[{"schema":{"type":"string"},"description":"the name of the configuration","name":"name","in":"path","required":true}],"responses":{"200":{"description":"Rollout evaluated; current configuration returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ConfigurationResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"404":{"description":"No configuration exists with the given name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}},"500":{"description":"Internal server error while updating the rollout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.ErrorResponse"}}}}}}}},"components":{"schemas":{"model.ConfigurationResponse":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/model.Configuration"},"raw":{"type":"string"}}},"model.Configuration":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the spec for the Configuration","allOf":[{"$ref":"#/components/schemas/model.ConfigurationSpec"}]},"status":{"$ref":"#/components/schemas/model.ConfigurationStatus"}}},"model.Kind":{"type":"string","enum":["Configuration","Agent","AgentType","AgentVersion","Source","Processor","Connector","Destination","Extension","SourceType","ProcessorType","ConnectorType","DestinationType","ExtensionType","RecommendationType","Unknown","Rollout","RolloutType","Organization","Account","Invitation","Login","User","AccountOrganizationBinding","UserOrganizationBinding","UserAccountBinding","AuditTrail","AvailableComponents","SecretsManagerType","SecretsManager","Recording","Credential","CredentialType","Fleet","Integration","IntegrationType","ConfigurationType","Notification","Recommendation","PublicProcessor","Blueprint","PrometheusRule","APIKey","ResourcePreset"]},"model.Metadata":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/model.AdditionalInfo"},"blueprintTags":{"description":"BlueprintTags holds categorized tags for blueprints (e.g., use-case, destination).\nUnlike Labels, this supports multiple values per category.","allOf":[{"$ref":"#/components/schemas/model.BlueprintTags"}]},"dateModified":{"type":"string"},"deprecated":{"description":"Deprecated indicates that this resource is deprecated and should not be used. Deprecated resources should contain\nadditional information about why the resource is deprecated and what should be used instead.\nNote: Ironically, the Deprecated field is itself deprecated. Use Stability instead.","type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"hash":{"description":"Hash is a hex formatted sha256 Hash of the json-encoded spec that is used to determine if the spec has changed.","type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"labels":{"$ref":"#/components/schemas/model.Labels"},"name":{"type":"string"},"resourceDocLink":{"type":"string"},"stability":{"description":"Stability is the stability of the resource, one of development, alpha, beta, stable, or\ndeprecated. This should be used instead of the Deprecated field.","allOf":[{"$ref":"#/components/schemas/model.Stability"}]},"version":{"description":"Version is a 1-based integer that is incremented each time the spec is changed.","type":"integer"},"warning":{"description":"Warning is an optional message that is displayed to the user when the resource is configured. Currently used for IntegrationTypes.","type":"string"}}},"model.AdditionalInfo":{"type":"object","properties":{"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"message":{"type":"string"}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"model.Labels":{"type":"object"},"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated","legacy",""]},"model.ConfigurationSpec":{"type":"object","properties":{"configurations":{"description":"Configurations references other Configuration resources by name.\nFor kubernetes-workload: references collector configurations to render into the CRD.\nFor kubernetes-operator: references workload configurations to package into the AgentConfigMap.","type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"contentType":{"type":"string"},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"disableLegacyEnvVarNormalization":{"type":"boolean"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"measurementInterval":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"raw":{"type":"string"},"rollout":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"selector":{"$ref":"#/components/schemas/model.AgentSelector"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"topologyInterval":{"type":"string"},"type":{"description":"Type determines the type of this configuration. Built-in values: \"\" (inferred),\n\"raw\", \"modular\". Any other value is a lookup key into the ConfigurationType registry\n(e.g., \"kubernetes-workload\", \"kubernetes-operator\").","type":"string"}}},"model.ResourceConfiguration":{"type":"object","properties":{"description":{"description":"Description is the description of the resource","type":"string"},"disabled":{"type":"boolean"},"displayName":{"description":"DisplayName is a friendly name of the resource that will be displayed in the UI","type":"string"},"id":{"description":"ID will be generated and is used to uniquely identify the resource","type":"string"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"name":{"description":"Name must be specified if this is a reference to another resource by name","type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"presetTarget":{"description":"PresetTarget identifies the resource type that this resource preset applies to.","allOf":[{"$ref":"#/components/schemas/model.ResourcePresetTarget"}]},"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceConfiguration"}},"public":{"type":"boolean"},"recommendation":{"description":"If this resource (currently only processors) was added to a configuration based on a recommendation, this field\nis set to the name of that recommendation type.","type":"string"},"routes":{"description":"Routes connect resources in a configuration","allOf":[{"$ref":"#/components/schemas/model.Routes"}]},"secOpsPipelineName":{"description":"SecOpsPipelineName is the name of the pipeline that this resource is associated with. This is used for the SecOps integration.","type":"string"},"telemetryExample":{"description":"TelemetryExample is an optional before/after example showing the transformation\na blueprint applies to telemetry data.","allOf":[{"$ref":"#/components/schemas/model.TelemetryExample"}]},"type":{"type":"string"},"version":{"type":"string"}}},"model.Parameter":{"type":"object","properties":{"credential":{"description":"Credential indicates if this parameter's value should be treated as a credential reference","type":"boolean"},"name":{"description":"Name is the name of the parameter","type":"string"},"sensitive":{"description":"Sensitive will be true if the value is sensitive and should be masked when printed.","type":"boolean"},"value":{"description":"Value could be any of the following: string, bool, int, enum (string), float, []string, map"}}},"model.ResourcePresetTarget":{"type":"object","properties":{"type":{"description":"Type is the resource type that this resource preset applies to.","type":"string"},"versionConstraint":{"description":"VersionConstraint is the constraint that allows this resource preset to only apply to specific versions.","type":"string"}}},"model.Routes":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics":{"description":"pairs (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+metrics+traces":{"description":"all three (alphabetical order)","type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"logs+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"metrics+traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}},"traces":{"type":"array","items":{"$ref":"#/components/schemas/model.Route"}}}},"model.Route":{"type":"object","properties":{"components":{"description":"Components is a list of component paths that identify a unique component in the configuration.","type":"array","items":{"type":"string"}},"id":{"description":"ID identifies this route in the routing table. It is used by the routing connector to\ncorrelate between conditions and the components connected to that condition. It is\noptional. If specified, it must be unique within the list of routes.","type":"string"}}},"model.TelemetryExample":{"type":"object","properties":{"after":{"description":"After is the structured telemetry after processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"before":{"description":"Before is the structured telemetry before processing","allOf":[{"$ref":"#/components/schemas/model.TelemetryExampleEntry"}]},"telemetryType":{"description":"TelemetryType indicates the kind of telemetry (e.g., \"log\", \"metric\", \"trace\")","type":"string"}}},"model.TelemetryExampleEntry":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{}},"body":{},"observedTimestamp":{"type":"string"},"resource":{"type":"object","additionalProperties":{}},"severityNumber":{"type":"integer"},"severityText":{"type":"string"},"timestamp":{"type":"string"}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.ConfigurationStatus":{"type":"object","properties":{"current":{"description":"Current will be set to true on read if the configuration is the current version","type":"boolean"},"currentVersion":{"description":"CurrentVersion is the version of the configuration that has most recently completed a rollout","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"latest":{"description":"Latest will be set to true on read if the configuration is the latest version","type":"boolean"},"pending":{"description":"Pending will be set to true on read if the configuration is the pending version","type":"boolean"},"pendingVersion":{"description":"PendingVersion will be set to the version of a rollout that is in progress. It will be set to 0 when the rollout\ncompletes.","allOf":[{"$ref":"#/components/schemas/model.Version"}]},"rollout":{"description":"Rollout contains status for the rollout of this configuration","allOf":[{"$ref":"#/components/schemas/model.Rollout"}]}}},"model.Version":{"type":"integer","enum":[-2,-1,0]},"model.Rollout":{"type":"object","properties":{"completedAt":{"description":"CompletedAt is the time the rollout was completed","type":"string"},"name":{"description":"Name will be set to the Name of the configuration when requested via Configuration.Rollout()","type":"string"},"options":{"description":"Options are set when the Rollout is created based on the rollout options specified in the configuration","allOf":[{"$ref":"#/components/schemas/model.RolloutOptions"}]},"phase":{"description":"Phase starts at zero and increments until all agents are updated. In each phase, initial*multiplier^phase agents will be updated.","type":"integer"},"progress":{"description":"Progress is the current progress of the rollout. The represents the overall progress\nof the rollout. If this is a progressive rollout, this will represent the sum of all\nstages.","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"stage":{"description":"Stage is the index of the current stage of the rollout","type":"integer"},"stages":{"description":"Stages are the RolloutProgress (Completed, Errors, Incompatible, Pending, and Waiting agents), Name and Labels for each stage of a progressive Rollout","type":"array","items":{"$ref":"#/components/schemas/model.RolloutStage"}},"startedAt":{"description":"StartedAt is the time the rollout was started","type":"string"},"status":{"description":"Status is the status of the rollout","allOf":[{"$ref":"#/components/schemas/model.RolloutStatus"}]}}},"model.RolloutOptions":{"type":"object","properties":{"maxErrors":{"description":"MaxErrors is the maximum number of failed agents before the rollout will be considered an error","type":"integer"},"phaseAgentCount":{"description":"PhaseAgentCount determines the rate at which agents will be updated during a rollout.","allOf":[{"$ref":"#/components/schemas/model.PhaseAgentCount"}]}}},"model.PhaseAgentCount":{"type":"object","properties":{"initial":{"type":"integer"},"maximum":{"type":"integer"},"multiplier":{"type":"number"},"type":{"$ref":"#/components/schemas/parameters.PhaseAgentCountType"}}},"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]},"model.RolloutProgress":{"type":"object","properties":{"completed":{"description":"Completed is the number of agents with new version with Connected status","type":"integer"},"errors":{"description":"Errors is the number of agents with new version with Error Status","type":"integer"},"incompatible":{"description":"Incompatible is the number of agents with new version with Incompatible Status","type":"integer"},"pending":{"description":"Pending is the number of agents that are currently being configured","type":"integer"},"waiting":{"description":"Waiting is the number of agents that need to be scheduled for configuration","type":"integer"}}},"model.RolloutStage":{"type":"object","properties":{"labels":{"description":"Agent labels that will be used to select agents to rollout to this stage","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"name":{"description":"Name of the stage","type":"string"},"progress":{"description":"Progress is the current progress of this rollout stage","allOf":[{"$ref":"#/components/schemas/model.RolloutProgress"}]},"startedAt":{"description":"StartedAt is the time the stage was started","type":"string"}}},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]},"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bindplane.com/cli-and-api/api/rollouts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.