Replicated supportBundle API
The supportBundle API from Replicated — 14 operation(s) for supportbundle.
Replicated supportBundle API is one of 22 APIs that Replicated publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include supportBundle. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an API reference.
This API exposes 15 operations across 14 paths, and defines 228 schemas. It is described by OpenAPI 2.0, at version 3.0.0.
Requests are made against the base URL https://api.replicated.com/vendor/v3.
15 operations
14 paths
228 schemas
1 DELETE8 GET4 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Replicated supportBundle API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key).
Paths & Operations 15
Across 14 paths, the API surfaces 15 operations — 1 DELETE, 8 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
supportBundle 15
POST
/app/{app_id}/supportbundle-command
Get a support bundle command for an app
GET
/supportbundle/upload-url
Get a presigned S3 support bundle upload URL + bundle ID.
GET
/supportbundle/{bundle_id}
Get support bundle analysis results.
DELETE
/supportbundle/{bundle_id}
Delete a support bundle.
POST
/supportbundle/{bundle_id}/analyze
Trigger analysis of a support bundle.
GET
/supportbundle/{bundle_id}/download
Download a support bundle.
GET
/supportbundle/{bundle_id}/events
Get parsed Kubernetes events from a support bundle.
POST
/supportbundle/{bundle_id}/files
Get files from a support bundle.
GET
/supportbundle/{bundle_id}/logs/{namespace}/{pod}
Get pod logs from a support bundle.
PUT
/supportbundle/{bundle_id}/name
Update a support bundle name.
GET
/supportbundle/{bundle_id}/pod
Get details about a single pod running when a support bundle was collected.
GET
/supportbundle/{bundle_id}/resources/{resource_type}
Get parsed Kubernetes resources from a support bundle.
PUT
/supportbundle/{bundle_id}/share
Share a support bundle with the requested teams.
POST
/supportbundle/{bundle_id}/uploaded
Set that a support bundle has been successfully uploaded.
GET
/supportbundles
List support bundles.
Schemas 228
The contract defines 228 schemas that model the data the API accepts and returns. The most detailed are Customer (54 properties), CustomerChannelWithDetail (43 properties), PodSpec (42 properties), SupportBundle (33 properties). Each schema is shown below with its type and property counts.
PersistentVolumeMode
string
+enum
PersistentVolumeClaimVolumeSource
object
This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume…
2 properties
VolumeProjection
object
Exactly one of these fields must be set.
6 properties
CustomerAdoption
object
7 properties
ContainerExtendedResourceRequest
object
extended resource name to the device request name.
3 properties
Customer
object
54 properties
LifecycleHandler
object
LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
4 properties
PodResourceClaimStatus
object
PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate. It stores the generated name for the corr…
2 properties
SecretProjection
object
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that t…
3 properties
OwnerReference
object
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster…
6 properties
SupportBundleStatus
string
PodSecurityContext
object
Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
13 properties
Lifecycle
object
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers,…
3 properties
EntitlementValues
array
SupportBundleSource
string
EphemeralContainer
object
To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.
26 properties
Toleration
object
The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .
5 properties
PreemptionPolicy
string
+enum
PodCertificateProjection
object
PodCertificateProjection provides a private key and X.509 certificate in the pod filesystem.
7 properties
SecretEnvSource
object
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
2 properties
GCEPersistentDiskVolumeSource
object
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read…
4 properties
ResourceHealth
object
This is a part of KEP https://kep.k8s.io/4680.
2 properties
IntOrString
object
+protobuf=true +protobuf.options.(gogoproto.goprotostringer)=false +k8s:openapi-gen=true +k8s:openapi-model-package=io.k8s.apimachinery.pkg.util.intstr
3 properties
GitHubRef
object
NodeSelectorRequirement
object
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
SleepAction
object
1 property
InstallerTypeReplicatedSDK
object
1 property
PodAffinityTerm
object
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-loca…
6 properties
ContainerResizePolicy
object
2 properties
TerminationMessagePolicy
string
+enum
PersistentVolumeClaimSpec
object
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
9 properties
PodConditionType
string
PodConditionType is a valid value for PodCondition.Type
FlexVolumeSource
object
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
5 properties
HostPathType
string
+enum
SeccompProfile
object
Only one profile source may be set. +union
2 properties
ImageVolumeSource
object
2 properties
EnvVar
object
3 properties
EnvFromSource
object
EnvFromSource represents the source of a set of ConfigMaps or Secrets
3 properties
PodStatus
object
PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot con…
20 properties
VulnCounts
object
5 properties
ConfigMapKeySelector
object
+structType=atomic
3 properties
CephFSVolumeSource
object
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
6 properties
VsphereVirtualDiskVolumeSource
object
4 properties
CustomerActions
object
4 properties
Affinity
object
3 properties
DownwardAPIProjection
object
Note that this is identical to a downwardAPI volume source without the default mode.
1 property
RecursiveReadOnlyMode
string
ContainerState
object
Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
3 properties
EPAccessMilestoneInfo
object
2 properties
ConfigMapEnvSource
object
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
2 properties
Signal
string
Signal defines the stop signal of containers +enum
DownwardAPIVolumeFile
object
DownwardAPIVolumeFile represents information to create the file containing the pod field
4 properties
CSIVolumeSource
object
Represents a source location of a volume to mount, managed by an external CSI driver
5 properties
FieldsV1
object
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will foll…
PodSpec
object
42 properties
ResourceFieldSelector
object
ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic
3 properties
DownwardAPIVolumeSource
object
Downward API volumes support ownership management and SELinux relabeling.
2 properties
DNSPolicy
string
+enum
ManagedFieldsEntry
object
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
7 properties
CustomerESInstance
object
7 properties
OSName
string
LintExpression
object
4 properties
InstallationTypeKurl
object
1 property
EmptyDirVolumeSource
object
Empty directory volumes support ownership management and SELinux relabeling.
2 properties
Quantity
object
The serialization format is: ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki |…
PodAffinity
object
2 properties
EventSeries
object
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
2 properties
AzureDataDiskCachingMode
string
+enum
SecretVolumeSource
object
The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes suppor…
4 properties
EnterprisePortalInfo
object
EnterprisePortalInfo contains Enterprise Portal status and timestamps for a customer
14 properties
CustomerInstance
object
24 properties
ConfigMapVolumeSource
object
The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items e…
4 properties
HTTPHeader
object
HTTPHeader describes a custom header to be used in HTTP probes
2 properties
StorageOSVolumeSource
object
5 properties
Type
integer
TolerationOperator
string
+enum
ContainerStatus
object
15 properties
PodAntiAffinity
object
2 properties
ServiceAccountTokenProjection
object
ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods…
3 properties
ContainerUser
object
ContainerUser represents user identity information
1 property
InstallerTypeHelm
object
ConditionStatus
string
VolumeResourceRequirements
object
2 properties
PodOS
object
1 property
InstallerTypePreflight
object
1 property
SecretKeySelector
object
+structType=atomic
3 properties
ContainerRestartRuleOnExitCodesOperator
string
ContainerRestartRuleOnExitCodesOperator describes the operator to take for the exit codes.
RBDVolumeSource
object
RBD volumes support ownership management and SELinux relabeling.
8 properties
PodFSGroupChangePolicy
string
PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume when volume is mounted. +enum
ProjectedVolumeSource
object
Represents a projected volume source
2 properties
PodExtendedResourceClaimStatus
object
PodExtendedResourceClaimStatus is stored in the PodStatus for the extended resource requests backed by DRA. It stores the generated name for the corresponding…
2 properties
VolumeMountStatus
object
4 properties
BundleEvent
object
9 properties
TCPSocketAction
object
TCPSocketAction describes an action based on opening a socket
2 properties
CustomerInstanceVersionHistory
object
9 properties
InstanceTags
array
Actor
object
5 properties
NodeInclusionPolicy
string
NodeInclusionPolicy defines the type of node inclusion policy +enum
EphemeralVolumeSource
object
1 property
HelmUnavailableResource
object
4 properties
EntitlementValue
object
3 properties
Container
object
25 properties
NodeSelectorTerm
object
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelecto…
2 properties
ExecAction
object
1 property
NodeSelector
object
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represente…
1 property
VolumeDevice
object
2 properties
AppArmorProfile
object
+union
2 properties
SeccompProfileType
string
+enum
GitRepoVolumeSource
object
DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount…
3 properties
AppArmorProfileType
string
+enum
Pod
object
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
19 properties
PodResourceClaim
object
It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.
3 properties
ManagedFieldsOperationType
string
ContainerRestartRule
object
2 properties
ResourceHealthStatus
string
ContainerStateWaiting
object
2 properties
InstallerTypeEmbeddedCluster
object
4 properties
InstanceTag
object
4 properties
HostPathVolumeSource
object
Host path volumes do not support ownership management or SELinux relabeling.
2 properties
EnvVarSource
object
5 properties
StorageMedium
string
PodDNSConfig
object
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
3 properties
URIScheme
string
URIScheme identifies the scheme used for connection to a host for Get actions +enum
TopologySpreadConstraint
object
8 properties
ConfigMapProjection
object
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless t…
3 properties
FlockerVolumeSource
object
One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
2 properties
QuobyteVolumeSource
object
Quobyte volumes do not support ownership management or SELinux relabeling.
6 properties
Event
object
Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers sh…
31 properties
PodReadinessGate
object
PodReadinessGate contains the reference to a pod condition
1 property
SecurityContext
object
Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
12 properties
LicenseType
string
HTTPGetAction
object
5 properties
Protocol
string
+enum
SupplementalGroupsPolicy
string
SupplementalGroupsPolicy defines how supplemental groups of the first container processes are calculated. +enum
InstallerTypeKotsConfig
object
1 property
PullPolicy
string
PullPolicy describes a policy for if/when to pull a container image +enum
ISCSIVolumeSource
object
ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
11 properties
PhotonPersistentDiskVolumeSource
object
2 properties
LinuxContainerUser
object
LinuxContainerUser represents user identity information in Linux containers
3 properties
PersistentVolumeClaimTemplate
object
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
16 properties
Capabilities
object
2 properties
GlusterfsVolumeSource
object
Glusterfs volumes do not support ownership management or SELinux relabeling.
3 properties
NodeAffinity
object
2 properties
ScaleIOVolumeSource
object
ScaleIOVolumeSource represents a persistent ScaleIO volume
10 properties
ContainerRestartRuleOnExitCodes
object
ContainerRestartRuleOnExitCodes describes the condition for handling an exited container based on its exit codes.
2 properties
ResourceStatus
object
2 properties
HelmInstallabilityIssue
object
2 properties
ResourceRequirements
object
3 properties
RestartPolicy
string
Only one of the following restart policies may be specified. If none of the following policies is specified, the default one is RestartPolicyAlways. +enum
VolumeMount
object
7 properties
CustomHostnameOverride
object
1 property
KotsChannelRelease
object
31 properties
TaintEffect
string
+enum
TotalActiveInactiveCustomers
object
3 properties
HelmChart
object
6 properties
InstallerTypeKots
object
2 properties
ObjectFieldSelector
object
+structType=atomic
2 properties
LabelSelector
object
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all object…
2 properties
InstanceSecuritySummary
object
InstanceSecuritySummary represents aggregated security information for an instance
3 properties
ResourceResizeRestartPolicy
string
ResourceID
string
DeviceID, where DeviceID is from the Device structure of DevicePlugin's ListAndWatchResponse type: https://github.com/kubernetes/kubernetes/blob/eda1c780543a27…
FileKeySelector
object
+structType=atomic
4 properties
LocalObjectReference
object
New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific…
1 property
PreferredSchedulingTerm
object
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is…
2 properties
LogEntry
object
2 properties
ContainerRestartPolicy
string
The only allowed values are "Always", "Never", and "OnFailure".
ProcMountType
string
+enum
GRPCAction
object
2 properties
PodPhase
string
+enum
ShipInstallStatus
object
2 properties
LabelSelectorOperator
string
TypedLocalObjectReference
object
New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Invalid usage help. It is impossible to add specific…
3 properties
InstallerTypeSupportBundle
object
1 property
PodResizeStatus
string
WorkloadReference
object
WorkloadReference identifies the Workload object and PodGroup membership that a Pod belongs to. The scheduler uses this information to apply workload-aware sch…
3 properties
PodSELinuxChangePolicy
string
CustomerChannelWithDetail
object
43 properties
HostAlias
object
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
2 properties
BundleScope
object
10 properties
TypedObjectReference
object
TypedObjectReference contains enough information to let you locate the typed referenced object
4 properties
ClusterTrustBundleProjection
object
ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.
5 properties
InstancePreview
object
3 properties
Volume
object
31 properties
SELinuxOptions
object
SELinuxOptions are the labels to be applied to the container
4 properties
Capability
string
Capability represent POSIX capabilities type
SoftwarePullMilestoneInfo
object
3 properties
ImageVulnCounts
object
16 properties
WeightedPodAffinityTerm
object
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
2 properties
ObjectReference
object
New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Ignored fields. It includes many fields which are no…
7 properties
NFSVolumeSource
object
NFS volumes do not support ownership management or SELinux relabeling.
3 properties
LintResult
object
2 properties
Sysctl
object
Sysctl defines a kernel parameter to be set
2 properties
ContainerRestartRuleAction
string
ContainerRestartRuleAction describes the action to take when the container exits.
PodDNSConfigOption
object
2 properties
MountPropagationMode
string
+enum
SupportBundleInsight
object
8 properties
CustomHostnameOverrides
object
4 properties
ContainerPort
object
5 properties
ContainerStateTerminated
object
7 properties
EventSource
object
2 properties
SupportBundle
object
33 properties
ResourceList
object
AWSElasticBlockStoreVolumeSource
object
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as re…
4 properties
FCVolumeSource
object
Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
5 properties
AzureDataDiskKind
string
+enum
ResourceClaim
object
2 properties
PodContainer
object
3 properties
InstallationTypes
object
9 properties
ResourceName
string
PortworxVolumeSource
object
3 properties
KeyToPath
object
3 properties
PodQOSClass
string
+enum
ExtraLintRules
object
PersistentVolumeAccessMode
string
+enum
HostIP
object
1 property
UID
string
UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps…
PodSchedulingGate
object
1 property
AzureFileVolumeSource
object
3 properties
PodIP
object
1 property
UnsatisfiableConstraintAction
string
+enum
ContainerStateRunning
object
1 property
LabelSelectorRequirement
object
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
NodeSelectorOperator
string
A node selector operator is the set of operators that can be used in a node selector requirement. +enum
Probe
object
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
10 properties
PodCondition
object
7 properties
CinderVolumeSource
object
A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership manageme…
4 properties
AzureDiskVolumeSource
object
6 properties
WindowsSecurityContextOptions
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Replicated 12
Other APIs Replicated publishes across the network.
Replicated apps API
Replicated channelReleases API
Replicated channels API
Replicated clusterAddons API
Replicated clusters API
Replicated cmx API
Replicated customers API
Replicated customHostnames API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated instances API
Replicated networks API
#supportBundle