# Models ## The auth.Role object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"auth.Role":{"type":"string","enum":["admin","user","viewer","agent",""]}}}} ``` ## The model.Account object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"}}}} ``` ## The model.AccountResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AccountResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/model.Account"}}},"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"}}}} ``` ## The model.AccountSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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"}}}}}} ``` ## The model.AccountsForOrganizationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AccountsForOrganizationResponse":{"description":"Body of the response to retrieve all accounts associated with an organization","type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/model.Account"}}}},"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"}}}} ``` ## The model.AccountsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AccountsResponse":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/model.Account"}}}},"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"}}}} ``` ## The model.AddSecretKeyResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AddSecretKeyResponse":{"type":"object","properties":{"secretKey":{"description":"SecretKey is the secret key that was added.","type":"string"}}}}}} ``` ## The model.AddUserPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AddUserPayload":{"description":"Body of the request to add a user to an account","type":"object","properties":{"create":{"description":"Create should be true if the user should be created if they do not exist","type":"boolean"},"email":{"description":"Email address of the user to add","type":"string"},"name":{"description":"Name of the user to add","type":"string"}}}}}} ``` ## The model.AdditionalInfo object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.Agent object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Agent":{"type":"object","properties":{"arch":{"type":"string"},"available_components_hash":{"type":"string"},"configuration":{"description":"tracked by Bindplane"},"configurationStatus":{"$ref":"#/components/schemas/model.ConfigurationVersions"},"connectedAt":{"type":"string"},"disconnectedAt":{"type":"string"},"errorMessage":{"type":"string"},"features":{"$ref":"#/components/schemas/model.AgentFeatures"},"fleet":{"description":"Fleet is the name of the fleet that the agent is a member of. Because this can be\nspecified by the fleet: label on the agent, it is possible that the fleet with this\nname does not exist.","type":"string"},"fleetStatus":{"description":"FleetStatus is the status of the agent's fleet assignment.","allOf":[{"$ref":"#/components/schemas/model.AgentFleetStatus"}]},"hostname":{"type":"string"},"id":{"type":"string"},"labels":{"description":"Labels are the current labels for the agent.","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"labels_bootstrapped":{"description":"LabelsBootstrapped is true if the labels have been \"bootstrapped\" (meaning, the initial labels have been set).\nWhen this is true, labels in the agent description are not applied. This is set to true after the initial agent labels are set.","type":"boolean"},"macAddress":{"type":"string"},"name":{"type":"string"},"operatingSystem":{"type":"string"},"outOfDate":{"type":"boolean"},"pendingLabels":{"description":"PendingLabels are deprecated, and should not be used.\nInstead, merge extra labels into Labels to modify the agent labels.","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"platform":{"type":"string"},"protocol":{"type":"string"},"remoteAddress":{"type":"string"},"reported_at":{"description":"ReportedAt is the time the agent last reported.","type":"string"},"state":{},"status":{"description":"reported by Status messages","allOf":[{"$ref":"#/components/schemas/model.AgentStatus"}]},"type":{"description":"Type should match the AgentType of this collector. This value is set from the \"service.name\" attribute in the\nOpAMP AgentDescription.","type":"string"},"upgrade":{"description":"Upgrade stores information about an agent upgrade","allOf":[{"$ref":"#/components/schemas/model.AgentUpgrade"}]},"version":{"type":"string"}}},"model.ConfigurationVersions":{"type":"object","properties":{"assigned":{"description":"Assigned is the configuration that has been assigned to the agent. It may not be\nrolled out to the agent. Use Current for the configuration actually in use by the\nAgent. This will be the name of the configuration and will not have a version\nassociated with it.","type":"string"},"current":{"description":"Current is the configuration currently applied to the agent.","type":"string"},"currentStage":{"description":"CurrentStage is the stage of the Current configuration","type":"integer","format":"int16"},"dirty":{"description":"Dirty is true if the assigned configuration has been modified but it has not been\napplied to the agent via Future/Pending/Current.","type":"boolean"},"future":{"description":"Future is the configuration that this agent is scheduled for when a rollout starts.\nAs the rollout progresses, this value becomes Pending and this will be cleared.","type":"string"},"futureStage":{"description":"FutureStage is the stage of the Future configuration","type":"integer","format":"int16"},"pending":{"description":"Pending is the configuration that OPAMP has been notified via the event bus to apply to this agent.\nOnce this configuration is confirmed, Current will be set to this value and this will be cleared.","type":"string"},"pendingSetAt":{"type":"string"},"pendingStage":{"description":"PendingStage is the stage of the Pending configuration","type":"integer","format":"int16"}}},"model.AgentFeatures":{"type":"integer","enum":[1,2,4,8,16,32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536,257]},"model.AgentFleetStatus":{"type":"integer","enum":[0,1,2]},"model.Labels":{"type":"object"},"model.AgentStatus":{"type":"integer","enum":[0,1,2,4,5,6,7,8,9]},"model.AgentUpgrade":{"type":"object","properties":{"allPackagesHash":{"description":"AllPackagesHash is the hash of the packages sent to the agent to upgrade","type":"array","items":{"type":"integer"}},"error":{"description":"Error is set if there were errors upgrading the agent","type":"string"},"status":{"description":"Status indicates the progress of the agent upgrade","allOf":[{"$ref":"#/components/schemas/model.AgentUpgradeStatus"}]},"version":{"description":"Version is used to indicate that an agent should be or is being upgraded. The agent status will be set to Upgrading\nwhen the upgrade begins.","type":"string"}}},"model.AgentUpgradeStatus":{"type":"integer","enum":[0,1,2]}}}} ``` ## The model.AgentDownload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentDownload":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}}}}} ``` ## The model.AgentFeatures object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentFeatures":{"type":"integer","enum":[1,2,4,8,16,32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536,257]}}}} ``` ## The model.AgentFleetStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentFleetStatus":{"type":"integer","enum":[0,1,2]}}}} ``` ## The model.AgentInstaller object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentInstaller":{"type":"object","properties":{"url":{"type":"string"}}}}}} ``` ## The model.AgentLabelsPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentLabelsPayload":{"type":"object","properties":{"labels":{"type":"object","additionalProperties":{"type":"string"}}}}}}} ``` ## The model.AgentLabelsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentLabelsResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"labels":{"$ref":"#/components/schemas/model.Labels"}}},"model.Labels":{"type":"object"}}}} ``` ## The model.AgentResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentResponse":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/model.Agent"}}},"model.Agent":{"type":"object","properties":{"arch":{"type":"string"},"available_components_hash":{"type":"string"},"configuration":{"description":"tracked by Bindplane"},"configurationStatus":{"$ref":"#/components/schemas/model.ConfigurationVersions"},"connectedAt":{"type":"string"},"disconnectedAt":{"type":"string"},"errorMessage":{"type":"string"},"features":{"$ref":"#/components/schemas/model.AgentFeatures"},"fleet":{"description":"Fleet is the name of the fleet that the agent is a member of. Because this can be\nspecified by the fleet: label on the agent, it is possible that the fleet with this\nname does not exist.","type":"string"},"fleetStatus":{"description":"FleetStatus is the status of the agent's fleet assignment.","allOf":[{"$ref":"#/components/schemas/model.AgentFleetStatus"}]},"hostname":{"type":"string"},"id":{"type":"string"},"labels":{"description":"Labels are the current labels for the agent.","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"labels_bootstrapped":{"description":"LabelsBootstrapped is true if the labels have been \"bootstrapped\" (meaning, the initial labels have been set).\nWhen this is true, labels in the agent description are not applied. This is set to true after the initial agent labels are set.","type":"boolean"},"macAddress":{"type":"string"},"name":{"type":"string"},"operatingSystem":{"type":"string"},"outOfDate":{"type":"boolean"},"pendingLabels":{"description":"PendingLabels are deprecated, and should not be used.\nInstead, merge extra labels into Labels to modify the agent labels.","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"platform":{"type":"string"},"protocol":{"type":"string"},"remoteAddress":{"type":"string"},"reported_at":{"description":"ReportedAt is the time the agent last reported.","type":"string"},"state":{},"status":{"description":"reported by Status messages","allOf":[{"$ref":"#/components/schemas/model.AgentStatus"}]},"type":{"description":"Type should match the AgentType of this collector. This value is set from the \"service.name\" attribute in the\nOpAMP AgentDescription.","type":"string"},"upgrade":{"description":"Upgrade stores information about an agent upgrade","allOf":[{"$ref":"#/components/schemas/model.AgentUpgrade"}]},"version":{"type":"string"}}},"model.ConfigurationVersions":{"type":"object","properties":{"assigned":{"description":"Assigned is the configuration that has been assigned to the agent. It may not be\nrolled out to the agent. Use Current for the configuration actually in use by the\nAgent. This will be the name of the configuration and will not have a version\nassociated with it.","type":"string"},"current":{"description":"Current is the configuration currently applied to the agent.","type":"string"},"currentStage":{"description":"CurrentStage is the stage of the Current configuration","type":"integer","format":"int16"},"dirty":{"description":"Dirty is true if the assigned configuration has been modified but it has not been\napplied to the agent via Future/Pending/Current.","type":"boolean"},"future":{"description":"Future is the configuration that this agent is scheduled for when a rollout starts.\nAs the rollout progresses, this value becomes Pending and this will be cleared.","type":"string"},"futureStage":{"description":"FutureStage is the stage of the Future configuration","type":"integer","format":"int16"},"pending":{"description":"Pending is the configuration that OPAMP has been notified via the event bus to apply to this agent.\nOnce this configuration is confirmed, Current will be set to this value and this will be cleared.","type":"string"},"pendingSetAt":{"type":"string"},"pendingStage":{"description":"PendingStage is the stage of the Pending configuration","type":"integer","format":"int16"}}},"model.AgentFeatures":{"type":"integer","enum":[1,2,4,8,16,32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536,257]},"model.AgentFleetStatus":{"type":"integer","enum":[0,1,2]},"model.Labels":{"type":"object"},"model.AgentStatus":{"type":"integer","enum":[0,1,2,4,5,6,7,8,9]},"model.AgentUpgrade":{"type":"object","properties":{"allPackagesHash":{"description":"AllPackagesHash is the hash of the packages sent to the agent to upgrade","type":"array","items":{"type":"integer"}},"error":{"description":"Error is set if there were errors upgrading the agent","type":"string"},"status":{"description":"Status indicates the progress of the agent upgrade","allOf":[{"$ref":"#/components/schemas/model.AgentUpgradeStatus"}]},"version":{"description":"Version is used to indicate that an agent should be or is being upgraded. The agent status will be set to Upgrading\nwhen the upgrade begins.","type":"string"}}},"model.AgentUpgradeStatus":{"type":"integer","enum":[0,1,2]}}}} ``` ## The model.AgentSelector object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}}}}} ``` ## The model.AgentStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentStatus":{"type":"integer","enum":[0,1,2,4,5,6,7,8,9]}}}} ``` ## The model.AgentType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AgentTypeSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentTypeSpec":{"type":"object","properties":{"platformArchSet":{"type":"array","items":{"$ref":"#/components/schemas/model.PlatformArch"}},"repositoryLink":{"type":"string"},"versionClient":{"type":"string"}}},"model.PlatformArch":{"type":"object","properties":{"arch":{"type":"string"},"platform":{"type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AgentTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentTypeResponse":{"type":"object","properties":{"agentType":{"$ref":"#/components/schemas/model.AgentType"}}},"model.AgentType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AgentTypeSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentTypeSpec":{"type":"object","properties":{"platformArchSet":{"type":"array","items":{"$ref":"#/components/schemas/model.PlatformArch"}},"repositoryLink":{"type":"string"},"versionClient":{"type":"string"}}},"model.PlatformArch":{"type":"object","properties":{"arch":{"type":"string"},"platform":{"type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AgentTypeSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentTypeSpec":{"type":"object","properties":{"platformArchSet":{"type":"array","items":{"$ref":"#/components/schemas/model.PlatformArch"}},"repositoryLink":{"type":"string"},"versionClient":{"type":"string"}}},"model.PlatformArch":{"type":"object","properties":{"arch":{"type":"string"},"platform":{"type":"string"}}}}}} ``` ## The model.AgentTypesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentTypesResponse":{"type":"object","properties":{"agentTypes":{"type":"array","items":{"$ref":"#/components/schemas/model.AgentType"}}}},"model.AgentType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AgentTypeSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentTypeSpec":{"type":"object","properties":{"platformArchSet":{"type":"array","items":{"$ref":"#/components/schemas/model.PlatformArch"}},"repositoryLink":{"type":"string"},"versionClient":{"type":"string"}}},"model.PlatformArch":{"type":"object","properties":{"arch":{"type":"string"},"platform":{"type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AgentUpgrade object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentUpgrade":{"type":"object","properties":{"allPackagesHash":{"description":"AllPackagesHash is the hash of the packages sent to the agent to upgrade","type":"array","items":{"type":"integer"}},"error":{"description":"Error is set if there were errors upgrading the agent","type":"string"},"status":{"description":"Status indicates the progress of the agent upgrade","allOf":[{"$ref":"#/components/schemas/model.AgentUpgradeStatus"}]},"version":{"description":"Version is used to indicate that an agent should be or is being upgraded. The agent status will be set to Upgrading\nwhen the upgrade begins.","type":"string"}}},"model.AgentUpgradeStatus":{"type":"integer","enum":[0,1,2]}}}} ``` ## The model.AgentUpgradeStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentUpgradeStatus":{"type":"integer","enum":[0,1,2]}}}} ``` ## The model.AgentVersion object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentVersion":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the agent version details including type, version string, release notes URL, and platform-specific installer and download entries","allOf":[{"$ref":"#/components/schemas/model.AgentVersionSpec"}]},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentVersionSpec":{"type":"object","properties":{"download":{"description":"Map of platform to download URL and hash","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentDownload"}},"draft":{"type":"boolean"},"installer":{"description":"Map of platform to installer script URL","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentInstaller"}},"prerelease":{"type":"boolean"},"releaseDate":{"description":"ReleaseDate is an RFC3339 encoded date in a string","type":"string"},"releaseNotesURL":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}}},"model.AgentDownload":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}},"model.AgentInstaller":{"type":"object","properties":{"url":{"type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AgentVersionDetailed object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentVersionDetailed":{"type":"object","properties":{"agentTypeDisplayName":{"type":"string"},"agentVersion":{"$ref":"#/components/schemas/model.AgentVersion"},"availableComponents":{"$ref":"#/components/schemas/model.AvailableComponents"}}},"model.AgentVersion":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the agent version details including type, version string, release notes URL, and platform-specific installer and download entries","allOf":[{"$ref":"#/components/schemas/model.AgentVersionSpec"}]},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentVersionSpec":{"type":"object","properties":{"download":{"description":"Map of platform to download URL and hash","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentDownload"}},"draft":{"type":"boolean"},"installer":{"description":"Map of platform to installer script URL","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentInstaller"}},"prerelease":{"type":"boolean"},"releaseDate":{"description":"ReleaseDate is an RFC3339 encoded date in a string","type":"string"},"releaseNotesURL":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}}},"model.AgentDownload":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}},"model.AgentInstaller":{"type":"object","properties":{"url":{"type":"string"}}},"model.NoStatus":{"type":"object"},"model.AvailableComponents":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AvailableComponentsSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"model.AvailableComponentsSpec":{"type":"object","properties":{"components":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}},"hash":{"type":"string"}}},"model.ComponentDetails":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/model.KeyValue"}},"sub_component_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}}}},"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}}}}} ``` ## The model.AgentVersionResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentVersionResponse":{"type":"object","properties":{"agentVersion":{"$ref":"#/components/schemas/model.AgentVersion"}}},"model.AgentVersion":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the agent version details including type, version string, release notes URL, and platform-specific installer and download entries","allOf":[{"$ref":"#/components/schemas/model.AgentVersionSpec"}]},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentVersionSpec":{"type":"object","properties":{"download":{"description":"Map of platform to download URL and hash","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentDownload"}},"draft":{"type":"boolean"},"installer":{"description":"Map of platform to installer script URL","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentInstaller"}},"prerelease":{"type":"boolean"},"releaseDate":{"description":"ReleaseDate is an RFC3339 encoded date in a string","type":"string"},"releaseNotesURL":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}}},"model.AgentDownload":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}},"model.AgentInstaller":{"type":"object","properties":{"url":{"type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AgentVersionSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentVersionSpec":{"type":"object","properties":{"download":{"description":"Map of platform to download URL and hash","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentDownload"}},"draft":{"type":"boolean"},"installer":{"description":"Map of platform to installer script URL","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentInstaller"}},"prerelease":{"type":"boolean"},"releaseDate":{"description":"ReleaseDate is an RFC3339 encoded date in a string","type":"string"},"releaseNotesURL":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}}},"model.AgentDownload":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}},"model.AgentInstaller":{"type":"object","properties":{"url":{"type":"string"}}}}}} ``` ## The model.AgentVersionsDetailedResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentVersionsDetailedResponse":{"type":"object","properties":{"agentVersions":{"type":"array","items":{"$ref":"#/components/schemas/model.AgentVersionDetailed"}}}},"model.AgentVersionDetailed":{"type":"object","properties":{"agentTypeDisplayName":{"type":"string"},"agentVersion":{"$ref":"#/components/schemas/model.AgentVersion"},"availableComponents":{"$ref":"#/components/schemas/model.AvailableComponents"}}},"model.AgentVersion":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the agent version details including type, version string, release notes URL, and platform-specific installer and download entries","allOf":[{"$ref":"#/components/schemas/model.AgentVersionSpec"}]},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentVersionSpec":{"type":"object","properties":{"download":{"description":"Map of platform to download URL and hash","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentDownload"}},"draft":{"type":"boolean"},"installer":{"description":"Map of platform to installer script URL","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentInstaller"}},"prerelease":{"type":"boolean"},"releaseDate":{"description":"ReleaseDate is an RFC3339 encoded date in a string","type":"string"},"releaseNotesURL":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}}},"model.AgentDownload":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}},"model.AgentInstaller":{"type":"object","properties":{"url":{"type":"string"}}},"model.NoStatus":{"type":"object"},"model.AvailableComponents":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AvailableComponentsSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"model.AvailableComponentsSpec":{"type":"object","properties":{"components":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}},"hash":{"type":"string"}}},"model.ComponentDetails":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/model.KeyValue"}},"sub_component_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}}}},"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}}}}} ``` ## The model.AgentVersionsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentVersionsResponse":{"type":"object","properties":{"agentVersions":{"type":"array","items":{"$ref":"#/components/schemas/model.AgentVersion"}}}},"model.AgentVersion":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"description":"Spec contains the agent version details including type, version string, release notes URL, and platform-specific installer and download entries","allOf":[{"$ref":"#/components/schemas/model.AgentVersionSpec"}]},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AgentVersionSpec":{"type":"object","properties":{"download":{"description":"Map of platform to download URL and hash","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentDownload"}},"draft":{"type":"boolean"},"installer":{"description":"Map of platform to installer script URL","type":"object","additionalProperties":{"$ref":"#/components/schemas/model.AgentInstaller"}},"prerelease":{"type":"boolean"},"releaseDate":{"description":"ReleaseDate is an RFC3339 encoded date in a string","type":"string"},"releaseNotesURL":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}}},"model.AgentDownload":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}},"model.AgentInstaller":{"type":"object","properties":{"url":{"type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AgentsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AgentsResponse":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/model.Agent"}}}},"model.Agent":{"type":"object","properties":{"arch":{"type":"string"},"available_components_hash":{"type":"string"},"configuration":{"description":"tracked by Bindplane"},"configurationStatus":{"$ref":"#/components/schemas/model.ConfigurationVersions"},"connectedAt":{"type":"string"},"disconnectedAt":{"type":"string"},"errorMessage":{"type":"string"},"features":{"$ref":"#/components/schemas/model.AgentFeatures"},"fleet":{"description":"Fleet is the name of the fleet that the agent is a member of. Because this can be\nspecified by the fleet: label on the agent, it is possible that the fleet with this\nname does not exist.","type":"string"},"fleetStatus":{"description":"FleetStatus is the status of the agent's fleet assignment.","allOf":[{"$ref":"#/components/schemas/model.AgentFleetStatus"}]},"hostname":{"type":"string"},"id":{"type":"string"},"labels":{"description":"Labels are the current labels for the agent.","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"labels_bootstrapped":{"description":"LabelsBootstrapped is true if the labels have been \"bootstrapped\" (meaning, the initial labels have been set).\nWhen this is true, labels in the agent description are not applied. This is set to true after the initial agent labels are set.","type":"boolean"},"macAddress":{"type":"string"},"name":{"type":"string"},"operatingSystem":{"type":"string"},"outOfDate":{"type":"boolean"},"pendingLabels":{"description":"PendingLabels are deprecated, and should not be used.\nInstead, merge extra labels into Labels to modify the agent labels.","allOf":[{"$ref":"#/components/schemas/model.Labels"}]},"platform":{"type":"string"},"protocol":{"type":"string"},"remoteAddress":{"type":"string"},"reported_at":{"description":"ReportedAt is the time the agent last reported.","type":"string"},"state":{},"status":{"description":"reported by Status messages","allOf":[{"$ref":"#/components/schemas/model.AgentStatus"}]},"type":{"description":"Type should match the AgentType of this collector. This value is set from the \"service.name\" attribute in the\nOpAMP AgentDescription.","type":"string"},"upgrade":{"description":"Upgrade stores information about an agent upgrade","allOf":[{"$ref":"#/components/schemas/model.AgentUpgrade"}]},"version":{"type":"string"}}},"model.ConfigurationVersions":{"type":"object","properties":{"assigned":{"description":"Assigned is the configuration that has been assigned to the agent. It may not be\nrolled out to the agent. Use Current for the configuration actually in use by the\nAgent. This will be the name of the configuration and will not have a version\nassociated with it.","type":"string"},"current":{"description":"Current is the configuration currently applied to the agent.","type":"string"},"currentStage":{"description":"CurrentStage is the stage of the Current configuration","type":"integer","format":"int16"},"dirty":{"description":"Dirty is true if the assigned configuration has been modified but it has not been\napplied to the agent via Future/Pending/Current.","type":"boolean"},"future":{"description":"Future is the configuration that this agent is scheduled for when a rollout starts.\nAs the rollout progresses, this value becomes Pending and this will be cleared.","type":"string"},"futureStage":{"description":"FutureStage is the stage of the Future configuration","type":"integer","format":"int16"},"pending":{"description":"Pending is the configuration that OPAMP has been notified via the event bus to apply to this agent.\nOnce this configuration is confirmed, Current will be set to this value and this will be cleared.","type":"string"},"pendingSetAt":{"type":"string"},"pendingStage":{"description":"PendingStage is the stage of the Pending configuration","type":"integer","format":"int16"}}},"model.AgentFeatures":{"type":"integer","enum":[1,2,4,8,16,32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536,257]},"model.AgentFleetStatus":{"type":"integer","enum":[0,1,2]},"model.Labels":{"type":"object"},"model.AgentStatus":{"type":"integer","enum":[0,1,2,4,5,6,7,8,9]},"model.AgentUpgrade":{"type":"object","properties":{"allPackagesHash":{"description":"AllPackagesHash is the hash of the packages sent to the agent to upgrade","type":"array","items":{"type":"integer"}},"error":{"description":"Error is set if there were errors upgrading the agent","type":"string"},"status":{"description":"Status indicates the progress of the agent upgrade","allOf":[{"$ref":"#/components/schemas/model.AgentUpgradeStatus"}]},"version":{"description":"Version is used to indicate that an agent should be or is being upgraded. The agent status will be set to Upgrading\nwhen the upgrade begins.","type":"string"}}},"model.AgentUpgradeStatus":{"type":"integer","enum":[0,1,2]}}}} ``` ## The model.AllOrganizationsAccountsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AllOrganizationsAccountsResponse":{"type":"object","properties":{"activeAccountId":{"type":"string"},"organizationAccounts":{"type":"array","items":{"$ref":"#/components/schemas/model.OrganizationAccounts"}}}},"model.OrganizationAccounts":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/model.Account"}},"organization":{"$ref":"#/components/schemas/model.Organization"},"ssoEnabled":{"type":"boolean"}}},"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"},"model.Organization":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.OrganizationSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"model.OrganizationSpec":{"type":"object","properties":{"auth0":{"$ref":"#/components/schemas/model.OrganizationAuth0"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}}}},"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The model.AnyResource object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AnyResource":{"type":"object"}}}} ``` ## The model.ApplyPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ApplyPayload":{"type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/model.AnyResource"}}}},"model.AnyResource":{"type":"object"}}}} ``` ## The model.ApplyResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ApplyResponse":{"type":"object","properties":{"updates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceStatus"}}}},"model.ResourceStatus":{"type":"object","properties":{"before":{"description":"Before is the resource before the update, currently only used for audit events and omitted from API responses"},"reason":{"description":"Reason will be set if status is invalid or error","type":"string"},"resource":{"description":"Resource is the resource that was updated"},"status":{"description":"Status is the status of the resource after the update","allOf":[{"$ref":"#/components/schemas/model.UpdateStatus"}]}}},"model.UpdateStatus":{"type":"string","enum":["unchanged","configured","created","deleted","not-found","invalid","error","in-use","forbidden","deprecated"]}}}} ``` ## The model.AuditEvent object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AuditEvent":{"type":"object","properties":{"account":{"description":"Account is the account that the event occurred on. May be nil in the case of single-account.","type":"string"},"action":{"description":"Action is the action that was taken on the resource","type":"string"},"configuration":{"description":"Configuration is the name of the configuration affected. This may be nil if there is not associated configuration.","type":"string"},"description":{"description":"Description is a readable description of the event","type":"string"},"id":{"description":"ID is a ULID uniquely identifying this event","type":"string"},"resourceKind":{"description":"ResourceKind is the resource that was modified","allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"resourceName":{"description":"ResourceName is the resource name","type":"string"},"timestamp":{"description":"Timestamp is the time this event occurred","type":"string"},"user":{"description":"User is the user that modified the resource","type":"string"}}},"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"]}}}} ``` ## The model.AvailableComponents object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AvailableComponents":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AvailableComponentsSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AvailableComponentsSpec":{"type":"object","properties":{"components":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}},"hash":{"type":"string"}}},"model.ComponentDetails":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/model.KeyValue"}},"sub_component_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}}}},"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AvailableComponentsHashResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AvailableComponentsHashResponse":{"type":"object","properties":{"availableComponents":{"$ref":"#/components/schemas/model.AvailableComponents"}}},"model.AvailableComponents":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AvailableComponentsSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AvailableComponentsSpec":{"type":"object","properties":{"components":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}},"hash":{"type":"string"}}},"model.ComponentDetails":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/model.KeyValue"}},"sub_component_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}}}},"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AvailableComponentsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AvailableComponentsResponse":{"type":"object","properties":{"availableComponents":{"type":"array","items":{"$ref":"#/components/schemas/model.AvailableComponents"}}}},"model.AvailableComponents":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AvailableComponentsSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AvailableComponentsSpec":{"type":"object","properties":{"components":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}},"hash":{"type":"string"}}},"model.ComponentDetails":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/model.KeyValue"}},"sub_component_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}}}},"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.AvailableComponentsSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.AvailableComponentsSpec":{"type":"object","properties":{"components":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}},"hash":{"type":"string"}}},"model.ComponentDetails":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/model.KeyValue"}},"sub_component_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}}}},"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}}}}} ``` ## The model.BlueprintResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.BlueprintResponse":{"type":"object","properties":{"blueprint":{"$ref":"#/components/schemas/model.Processor"}}},"model.Processor":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.BlueprintTags object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.BlueprintTags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}} ``` ## The model.BlueprintsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.BlueprintsResponse":{"type":"object","properties":{"blueprints":{"type":"array","items":{"$ref":"#/components/schemas/model.Processor"}}}},"model.Processor":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.BulkAgentLabelsPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.BulkAgentLabelsPayload":{"description":"Body of the request to update labels for multiple agents","type":"object","properties":{"ids":{"description":"IDs is the list of agent IDs to update","type":"array","items":{"type":"string"}},"includeFailedIds":{"description":"IncludeFailedIDs when true, and when IDs are provided, will include the IDs that failed to update\nin the BulkAgentLabelsResponse under the \"failedIds\" field.","type":"boolean"},"labels":{"description":"Labels are name/value pairs of labels to update. Empty values indicate that the label should be deleted.","type":"object","additionalProperties":{"type":"string"}},"overwrite":{"description":"Overwrite is true if the labels should be overwritten. Must be true if modifying a pre-existing label value.","type":"boolean"},"query":{"description":"Query is a query string to find agents to update, e.g. \"env:production\". A query can\nmatch fields or labels on the agent.","type":"string"},"selector":{"description":"Selector is the selector to find agents to update, e.g. \"env=production\". A selector\nmatches labels on the agent and supports \"!\", \"=\", \"==\", \"in\", \"!=\", \"notin\", and\n\"exists\" operators.","type":"string"}}}}}} ``` ## The model.BulkAgentLabelsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.BulkAgentLabelsResponse":{"type":"object","properties":{"count":{"type":"integer"},"errors":{"type":"array","items":{"type":"string"}},"failedIds":{"description":"FailedIDs contains the IDs that failed to be updated when IncludeFailedIDs was requested","type":"array","items":{"type":"string"}}}}}}} ``` ## The model.ComponentDetails object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ComponentDetails":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/model.KeyValue"}},"sub_component_details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/model.ComponentDetails"}}}},"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}}}}} ``` ## The model.Configuration object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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",""]},"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]}}}} ``` ## The model.ConfigurationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"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",""]},"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]}}}} ``` ## The model.ConfigurationSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}} ``` ## The model.ConfigurationStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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.Labels":{"type":"object"},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]}}}} ``` ## The model.ConfigurationType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ConfigurationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ConfigurationTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ConfigurationTypeResponse":{"type":"object","properties":{"configurationType":{"$ref":"#/components/schemas/model.ConfigurationType"}}},"model.ConfigurationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ConfigurationTypesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ConfigurationTypesResponse":{"type":"object","properties":{"configurationTypes":{"type":"array","items":{"$ref":"#/components/schemas/model.ConfigurationType"}}}},"model.ConfigurationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ConfigurationVersions object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ConfigurationVersions":{"type":"object","properties":{"assigned":{"description":"Assigned is the configuration that has been assigned to the agent. It may not be\nrolled out to the agent. Use Current for the configuration actually in use by the\nAgent. This will be the name of the configuration and will not have a version\nassociated with it.","type":"string"},"current":{"description":"Current is the configuration currently applied to the agent.","type":"string"},"currentStage":{"description":"CurrentStage is the stage of the Current configuration","type":"integer","format":"int16"},"dirty":{"description":"Dirty is true if the assigned configuration has been modified but it has not been\napplied to the agent via Future/Pending/Current.","type":"boolean"},"future":{"description":"Future is the configuration that this agent is scheduled for when a rollout starts.\nAs the rollout progresses, this value becomes Pending and this will be cleared.","type":"string"},"futureStage":{"description":"FutureStage is the stage of the Future configuration","type":"integer","format":"int16"},"pending":{"description":"Pending is the configuration that OPAMP has been notified via the event bus to apply to this agent.\nOnce this configuration is confirmed, Current will be set to this value and this will be cleared.","type":"string"},"pendingSetAt":{"type":"string"},"pendingStage":{"description":"PendingStage is the stage of the Pending configuration","type":"integer","format":"int16"}}}}}} ``` ## The model.ConfigurationsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"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",""]},"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]}}}} ``` ## The model.DeleteAgentsPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DeleteAgentsPayload":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The model.DeleteAgentsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DeleteAgentsResponse":{"type":"object","properties":{"agents":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The model.DeletePayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DeletePayload":{"type":"object"}}}} ``` ## The model.DeleteResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DeleteResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"updates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceStatus"}}}},"model.ResourceStatus":{"type":"object","properties":{"before":{"description":"Before is the resource before the update, currently only used for audit events and omitted from API responses"},"reason":{"description":"Reason will be set if status is invalid or error","type":"string"},"resource":{"description":"Resource is the resource that was updated"},"status":{"description":"Status is the status of the resource after the update","allOf":[{"$ref":"#/components/schemas/model.UpdateStatus"}]}}},"model.UpdateStatus":{"type":"string","enum":["unchanged","configured","created","deleted","not-found","invalid","error","in-use","forbidden","deprecated"]}}}} ``` ## The model.Destination object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Destination":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.DestinationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DestinationResponse":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/model.Destination"}}},"model.Destination":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.DestinationType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DestinationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.DestinationTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DestinationTypeResponse":{"type":"object","properties":{"destinationType":{"$ref":"#/components/schemas/model.DestinationType"}}},"model.DestinationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.DestinationTypesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DestinationTypesResponse":{"type":"object","properties":{"destinationTypes":{"type":"array","items":{"$ref":"#/components/schemas/model.DestinationType"}}}},"model.DestinationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.DestinationsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DestinationsResponse":{"type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/model.Destination"}}}},"model.Destination":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.DocumentationLink object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}}}}} ``` ## The model.ErrorResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The model.Extension object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Extension":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ExtensionResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ExtensionResponse":{"type":"object","properties":{"extension":{"$ref":"#/components/schemas/model.Extension"}}},"model.Extension":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ExtensionType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ExtensionType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ExtensionTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ExtensionTypeResponse":{"type":"object","properties":{"extensionType":{"$ref":"#/components/schemas/model.ExtensionType"}}},"model.ExtensionType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ExtensionTypesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ExtensionTypesResponse":{"type":"object","properties":{"extensionTypes":{"type":"array","items":{"$ref":"#/components/schemas/model.ExtensionType"}}}},"model.ExtensionType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ExtensionsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ExtensionsResponse":{"type":"object","properties":{"extensions":{"type":"array","items":{"$ref":"#/components/schemas/model.Extension"}}}},"model.Extension":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.Fleet object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Fleet":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.FleetSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.FleetSpec":{"type":"object","properties":{"configuration":{"description":"Configuration is the name of the configuration that is assigned to the fleet. It\nshould not have a version.","type":"string"},"selector":{"description":"Selector is the selector that is used to match agents to the fleet.","allOf":[{"$ref":"#/components/schemas/model.AgentSelector"}]}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.FleetSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.FleetSpec":{"type":"object","properties":{"configuration":{"description":"Configuration is the name of the configuration that is assigned to the fleet. It\nshould not have a version.","type":"string"},"selector":{"description":"Selector is the selector that is used to match agents to the fleet.","allOf":[{"$ref":"#/components/schemas/model.AgentSelector"}]}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}}}}} ``` ## The model.FleetsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.FleetsResponse":{"type":"object","properties":{"fleets":{"type":"array","items":{"$ref":"#/components/schemas/model.Fleet"}}}},"model.Fleet":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.FleetSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.FleetSpec":{"type":"object","properties":{"configuration":{"description":"Configuration is the name of the configuration that is assigned to the fleet. It\nshould not have a version.","type":"string"},"selector":{"description":"Selector is the selector that is used to match agents to the fleet.","allOf":[{"$ref":"#/components/schemas/model.AgentSelector"}]}}},"model.AgentSelector":{"type":"object","properties":{"matchLabels":{"$ref":"#/components/schemas/model.MatchLabels"}}},"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.GetOrganizationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.GetOrganizationResponse":{"description":"Body of the response to get an organization by name","type":"object","properties":{"organization":{"$ref":"#/components/schemas/model.Organization"}}},"model.Organization":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.OrganizationSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.OrganizationSpec":{"type":"object","properties":{"auth0":{"$ref":"#/components/schemas/model.OrganizationAuth0"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}}}},"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"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.NoStatus":{"type":"object"}}}} ``` ## The model.GetOrganizationsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.GetOrganizationsResponse":{"description":"Body of the response to get all organizations a user belongs to","type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/model.Organization"}}}},"model.Organization":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.OrganizationSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.OrganizationSpec":{"type":"object","properties":{"auth0":{"$ref":"#/components/schemas/model.OrganizationAuth0"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}}}},"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"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.NoStatus":{"type":"object"}}}} ``` ## The model.GetSecretKeysResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.GetSecretKeysResponse":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"defaultSecretKey":{"description":"DefaultSecretKey is the default secret key for the account.","type":"string"},"names":{"description":"Names are the names of the secret keys that can be used for an account.\nindex 0 is the default secret key, index 1+ are alternate secret key names","type":"array","items":{"type":"string"}}}}}}} ``` ## The model.HistoryResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.HistoryResponse":{"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/model.AnyResource"}}}},"model.AnyResource":{"type":"object"}}}} ``` ## The model.InsertOrganizationPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.InsertOrganizationPayload":{"description":"Body of the request to insert a new organization","type":"object","properties":{"accountName":{"type":"string"},"eulaAccepted":{"type":"boolean"},"licenseKey":{"description":"LicenseKey is an optional pre-existing license key to use instead of creating a new license.\nWhen provided, the system will validate and use this license instead of generating a new one.","type":"string"},"licenseType":{"type":"string"},"organizationName":{"type":"string"}}}}}} ``` ## The model.InsertOrganizationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.InsertOrganizationResponse":{"description":"Body of the response to create an organization and an account","type":"object","properties":{"account":{"$ref":"#/components/schemas/model.Account"},"organization":{"$ref":"#/components/schemas/model.Organization"}}},"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"},"model.Organization":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.OrganizationSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"model.OrganizationSpec":{"type":"object","properties":{"auth0":{"$ref":"#/components/schemas/model.OrganizationAuth0"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}}}},"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The model.InstallCommandResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.InstallCommandResponse":{"type":"object","properties":{"alternateCommand":{"type":"string"},"command":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The model.KeyValue object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"description":"TODO if non-string metadata is ever included, this will need to change","type":"string"}}}}}} ``` ## The model.Kind object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"]}}}} ``` ## The model.Labels object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Labels":{"type":"object"}}}} ``` ## The model.MatchLabels object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.MatchLabels":{"type":"object","additionalProperties":{"type":"string"}}}}} ``` ## The model.Metadata object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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",""]}}}} ``` ## The model.MetricCategory object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The model.MetricOption object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The model.NewAccountPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NewAccountPayload":{"type":"object","properties":{"displayName":{"type":"string"}}}}}} ``` ## The model.NewAccountResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NewAccountResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/model.Account"}}},"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"}}}} ``` ## The model.NoStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NoStatus":{"type":"object"}}}} ``` ## The model.Notification object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Notification":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.NotificationSpec"},"status":{"$ref":"#/components/schemas/model.NotificationStatusType"}}},"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",""]},"model.NotificationSpec":{"type":"object","properties":{"account":{"type":"string"},"adminOnly":{"description":"AdminOnly, when true, hides this notification from non-admin viewers in an organization.\nOrg-admin status is evaluated at the read path. Defaults to false for backwards compatibility.","type":"boolean"},"hidden":{"type":"boolean"},"notificationType":{"description":"NotificationType is used to determine the source of the notification.","allOf":[{"$ref":"#/components/schemas/model.NotificationType"}]},"organization":{"type":"string"},"recommendationId":{"type":"string"},"scope":{"$ref":"#/components/schemas/model.NotificationScope"},"severity":{"type":"string"},"userId":{"type":"string"}}},"model.NotificationType":{"type":"string","enum":["job","pipeline_intelligence","retool","programmatic","script"]},"model.NotificationScope":{"type":"string","enum":["global","account","user","organization"]},"model.NotificationStatusType":{"type":"object","properties":{"userStatus":{"description":"UserStatus is the status of the notification for the user.\nThis is the status that is stored in the user_notifications table, only used when NotificationsWithStatus is called.","allOf":[{"$ref":"#/components/schemas/model.NotificationStatus"}]}}},"model.NotificationStatus":{"type":"string","enum":["unread","read","dismissed","accepted","archived"]}}}} ``` ## The model.NotificationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NotificationResponse":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/model.Notification"}}},"model.Notification":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.NotificationSpec"},"status":{"$ref":"#/components/schemas/model.NotificationStatusType"}}},"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",""]},"model.NotificationSpec":{"type":"object","properties":{"account":{"type":"string"},"adminOnly":{"description":"AdminOnly, when true, hides this notification from non-admin viewers in an organization.\nOrg-admin status is evaluated at the read path. Defaults to false for backwards compatibility.","type":"boolean"},"hidden":{"type":"boolean"},"notificationType":{"description":"NotificationType is used to determine the source of the notification.","allOf":[{"$ref":"#/components/schemas/model.NotificationType"}]},"organization":{"type":"string"},"recommendationId":{"type":"string"},"scope":{"$ref":"#/components/schemas/model.NotificationScope"},"severity":{"type":"string"},"userId":{"type":"string"}}},"model.NotificationType":{"type":"string","enum":["job","pipeline_intelligence","retool","programmatic","script"]},"model.NotificationScope":{"type":"string","enum":["global","account","user","organization"]},"model.NotificationStatusType":{"type":"object","properties":{"userStatus":{"description":"UserStatus is the status of the notification for the user.\nThis is the status that is stored in the user_notifications table, only used when NotificationsWithStatus is called.","allOf":[{"$ref":"#/components/schemas/model.NotificationStatus"}]}}},"model.NotificationStatus":{"type":"string","enum":["unread","read","dismissed","accepted","archived"]}}}} ``` ## The model.NotificationScope object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NotificationScope":{"type":"string","enum":["global","account","user","organization"]}}}} ``` ## The model.NotificationSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NotificationSpec":{"type":"object","properties":{"account":{"type":"string"},"adminOnly":{"description":"AdminOnly, when true, hides this notification from non-admin viewers in an organization.\nOrg-admin status is evaluated at the read path. Defaults to false for backwards compatibility.","type":"boolean"},"hidden":{"type":"boolean"},"notificationType":{"description":"NotificationType is used to determine the source of the notification.","allOf":[{"$ref":"#/components/schemas/model.NotificationType"}]},"organization":{"type":"string"},"recommendationId":{"type":"string"},"scope":{"$ref":"#/components/schemas/model.NotificationScope"},"severity":{"type":"string"},"userId":{"type":"string"}}},"model.NotificationType":{"type":"string","enum":["job","pipeline_intelligence","retool","programmatic","script"]},"model.NotificationScope":{"type":"string","enum":["global","account","user","organization"]}}}} ``` ## The model.NotificationStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NotificationStatus":{"type":"string","enum":["unread","read","dismissed","accepted","archived"]}}}} ``` ## The model.NotificationStatusType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NotificationStatusType":{"type":"object","properties":{"userStatus":{"description":"UserStatus is the status of the notification for the user.\nThis is the status that is stored in the user_notifications table, only used when NotificationsWithStatus is called.","allOf":[{"$ref":"#/components/schemas/model.NotificationStatus"}]}}},"model.NotificationStatus":{"type":"string","enum":["unread","read","dismissed","accepted","archived"]}}}} ``` ## The model.NotificationType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NotificationType":{"type":"string","enum":["job","pipeline_intelligence","retool","programmatic","script"]}}}} ``` ## The model.NotificationsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.NotificationsResponse":{"type":"object","properties":{"notifications":{"type":"array","items":{"$ref":"#/components/schemas/model.Notification"}}}},"model.Notification":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.NotificationSpec"},"status":{"$ref":"#/components/schemas/model.NotificationStatusType"}}},"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",""]},"model.NotificationSpec":{"type":"object","properties":{"account":{"type":"string"},"adminOnly":{"description":"AdminOnly, when true, hides this notification from non-admin viewers in an organization.\nOrg-admin status is evaluated at the read path. Defaults to false for backwards compatibility.","type":"boolean"},"hidden":{"type":"boolean"},"notificationType":{"description":"NotificationType is used to determine the source of the notification.","allOf":[{"$ref":"#/components/schemas/model.NotificationType"}]},"organization":{"type":"string"},"recommendationId":{"type":"string"},"scope":{"$ref":"#/components/schemas/model.NotificationScope"},"severity":{"type":"string"},"userId":{"type":"string"}}},"model.NotificationType":{"type":"string","enum":["job","pipeline_intelligence","retool","programmatic","script"]},"model.NotificationScope":{"type":"string","enum":["global","account","user","organization"]},"model.NotificationStatusType":{"type":"object","properties":{"userStatus":{"description":"UserStatus is the status of the notification for the user.\nThis is the status that is stored in the user_notifications table, only used when NotificationsWithStatus is called.","allOf":[{"$ref":"#/components/schemas/model.NotificationStatus"}]}}},"model.NotificationStatus":{"type":"string","enum":["unread","read","dismissed","accepted","archived"]}}}} ``` ## The model.Organization object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Organization":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.OrganizationSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.OrganizationSpec":{"type":"object","properties":{"auth0":{"$ref":"#/components/schemas/model.OrganizationAuth0"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}}}},"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"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.NoStatus":{"type":"object"}}}} ``` ## The model.OrganizationAccounts object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.OrganizationAccounts":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/model.Account"}},"organization":{"$ref":"#/components/schemas/model.Organization"},"ssoEnabled":{"type":"boolean"}}},"model.Account":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.AccountSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.AccountSpec":{"type":"object","properties":{"alternateSecretKeys":{"description":"AlternateSecretKeys are additional secret keys that can be used for an account.","type":"array","items":{"type":"string"}},"names":{"description":"Names are labels for each secret key: index 0 is the default, indices 1+ match\nAlternateSecretKeys in order.","type":"array","items":{"type":"string"}},"parameters":{"description":"Parameters are the parameters for the account.","type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}},"secretKey":{"description":"SecretKey is the default secret key for an account.\nThis will be used when generating the install command for agents.","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.NoStatus":{"type":"object"},"model.Organization":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.OrganizationSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"model.OrganizationSpec":{"type":"object","properties":{"auth0":{"$ref":"#/components/schemas/model.OrganizationAuth0"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}}}},"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The model.OrganizationAuth0 object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The model.OrganizationSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.OrganizationSpec":{"type":"object","properties":{"auth0":{"$ref":"#/components/schemas/model.OrganizationAuth0"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/model.Parameter"}}}},"model.OrganizationAuth0":{"type":"object","properties":{"displayName":{"type":"string"},"id":{"type":"string"},"name":{"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"}}}}}} ``` ## The model.Parameter object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.ParameterDefinition object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}}}}} ``` ## The model.ParameterOptions object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The model.ParameterizedSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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"}}}}}} ``` ## The model.PatchAgentVersionsRequest object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.PatchAgentVersionsRequest":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"version":{"type":"string"}}}}}} ``` ## The model.PatchOrganizationPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.PatchOrganizationPayload":{"description":"Body of the request to update organization metadata","type":"object","properties":{"name":{"description":"The updated organization name","type":"string"}}}}}} ``` ## The model.PhaseAgentCount object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"]}}}} ``` ## The model.PlatformArch object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.PlatformArch":{"type":"object","properties":{"arch":{"type":"string"},"platform":{"type":"string"}}}}}} ``` ## The model.PostAgentVersionRequest object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.PostAgentVersionRequest":{"type":"object","properties":{"version":{"type":"string"}}}}}} ``` ## The model.PostCopyConfigRequest object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.PostCopyConfigRequest":{"type":"object","properties":{"name":{"description":"The intended name of the duplicated config","type":"string"}}}}}} ``` ## The model.Processor object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Processor":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ProcessorResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ProcessorResponse":{"type":"object","properties":{"processor":{"$ref":"#/components/schemas/model.Processor"}}},"model.Processor":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ProcessorType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ProcessorType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ProcessorTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ProcessorTypeResponse":{"type":"object","properties":{"processorType":{"$ref":"#/components/schemas/model.ProcessorType"}}},"model.ProcessorType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ProcessorTypesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ProcessorTypesResponse":{"type":"object","properties":{"processorTypes":{"type":"array","items":{"$ref":"#/components/schemas/model.ProcessorType"}}}},"model.ProcessorType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.ProcessorsResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ProcessorsResponse":{"type":"object","properties":{"processors":{"type":"array","items":{"$ref":"#/components/schemas/model.Processor"}}}},"model.Processor":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.PutJanitorOrganizationLicensePayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.PutJanitorOrganizationLicensePayload":{"type":"object","properties":{"createLicenseType":{"type":"string"},"licenseKey":{"type":"string"}}}}}} ``` ## The model.RecommendationResources object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.RecommendationResources":{"type":"object","properties":{"destinationTypes":{"type":"array","items":{"type":"string"}},"sourceTypes":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The model.RecommendationType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.RecommendationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.RecommendationTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.RecommendationTypeSpec":{"type":"object","properties":{"acceptanceCriteria":{"description":"Either 'diff', 'reduced', 'resource', 'diff-resource', or 'none'","type":"string"},"candidateGeneratorFunc":{"description":"CandidateGeneratorFunc is the key of the target function in functions.go used to generate candidates at runtime","type":"string"},"checkParameters":{"description":"CheckParameters indicates if the recommendation type should check that parameters of existing processors are distinct before recommending","type":"boolean"},"pipelinePosition":{"description":"PipelinePosition is the position in the pipeline that the recommendation is for, either 'source' or 'destination'","type":"string"},"pipelineType":{"description":"A subset of ['logs', 'metrics', 'traces']","type":"array","items":{"type":"string"}},"resources":{"description":"Resource based recommendations will have a list of resources that the configuration\nmust have in order to be recommended","allOf":[{"$ref":"#/components/schemas/model.RecommendationResources"}]},"testProcessor":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"version":{"type":"string"}}},"model.RecommendationResources":{"type":"object","properties":{"destinationTypes":{"type":"array","items":{"type":"string"}},"sourceTypes":{"type":"array","items":{"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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.RecommendationTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.RecommendationTypeResponse":{"type":"object","properties":{"recommendationType":{"$ref":"#/components/schemas/model.RecommendationType"}}},"model.RecommendationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.RecommendationTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.RecommendationTypeSpec":{"type":"object","properties":{"acceptanceCriteria":{"description":"Either 'diff', 'reduced', 'resource', 'diff-resource', or 'none'","type":"string"},"candidateGeneratorFunc":{"description":"CandidateGeneratorFunc is the key of the target function in functions.go used to generate candidates at runtime","type":"string"},"checkParameters":{"description":"CheckParameters indicates if the recommendation type should check that parameters of existing processors are distinct before recommending","type":"boolean"},"pipelinePosition":{"description":"PipelinePosition is the position in the pipeline that the recommendation is for, either 'source' or 'destination'","type":"string"},"pipelineType":{"description":"A subset of ['logs', 'metrics', 'traces']","type":"array","items":{"type":"string"}},"resources":{"description":"Resource based recommendations will have a list of resources that the configuration\nmust have in order to be recommended","allOf":[{"$ref":"#/components/schemas/model.RecommendationResources"}]},"testProcessor":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"version":{"type":"string"}}},"model.RecommendationResources":{"type":"object","properties":{"destinationTypes":{"type":"array","items":{"type":"string"}},"sourceTypes":{"type":"array","items":{"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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.RecommendationTypeSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.RecommendationTypeSpec":{"type":"object","properties":{"acceptanceCriteria":{"description":"Either 'diff', 'reduced', 'resource', 'diff-resource', or 'none'","type":"string"},"candidateGeneratorFunc":{"description":"CandidateGeneratorFunc is the key of the target function in functions.go used to generate candidates at runtime","type":"string"},"checkParameters":{"description":"CheckParameters indicates if the recommendation type should check that parameters of existing processors are distinct before recommending","type":"boolean"},"pipelinePosition":{"description":"PipelinePosition is the position in the pipeline that the recommendation is for, either 'source' or 'destination'","type":"string"},"pipelineType":{"description":"A subset of ['logs', 'metrics', 'traces']","type":"array","items":{"type":"string"}},"resources":{"description":"Resource based recommendations will have a list of resources that the configuration\nmust have in order to be recommended","allOf":[{"$ref":"#/components/schemas/model.RecommendationResources"}]},"testProcessor":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"version":{"type":"string"}}},"model.RecommendationResources":{"type":"object","properties":{"destinationTypes":{"type":"array","items":{"type":"string"}},"sourceTypes":{"type":"array","items":{"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"}}}}}} ``` ## The model.RecommendationTypesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.RecommendationTypesResponse":{"type":"object","properties":{"recommendationTypes":{"type":"array","items":{"$ref":"#/components/schemas/model.RecommendationType"}}}},"model.RecommendationType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.RecommendationTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.RecommendationTypeSpec":{"type":"object","properties":{"acceptanceCriteria":{"description":"Either 'diff', 'reduced', 'resource', 'diff-resource', or 'none'","type":"string"},"candidateGeneratorFunc":{"description":"CandidateGeneratorFunc is the key of the target function in functions.go used to generate candidates at runtime","type":"string"},"checkParameters":{"description":"CheckParameters indicates if the recommendation type should check that parameters of existing processors are distinct before recommending","type":"boolean"},"pipelinePosition":{"description":"PipelinePosition is the position in the pipeline that the recommendation is for, either 'source' or 'destination'","type":"string"},"pipelineType":{"description":"A subset of ['logs', 'metrics', 'traces']","type":"array","items":{"type":"string"}},"resources":{"description":"Resource based recommendations will have a list of resources that the configuration\nmust have in order to be recommended","allOf":[{"$ref":"#/components/schemas/model.RecommendationResources"}]},"testProcessor":{"$ref":"#/components/schemas/model.ResourceConfiguration"},"version":{"type":"string"}}},"model.RecommendationResources":{"type":"object","properties":{"destinationTypes":{"type":"array","items":{"type":"string"}},"sourceTypes":{"type":"array","items":{"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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.RelevantIfCondition object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}}}}} ``` ## The model.ResourceConfiguration object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.ResourcePresetTarget object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.ResourceResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourceResponse":{"type":"object","properties":{"resource":{}}}}}} ``` ## The model.ResourceStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourceStatus":{"type":"object","properties":{"before":{"description":"Before is the resource before the update, currently only used for audit events and omitted from API responses"},"reason":{"description":"Reason will be set if status is invalid or error","type":"string"},"resource":{"description":"Resource is the resource that was updated"},"status":{"description":"Status is the status of the resource after the update","allOf":[{"$ref":"#/components/schemas/model.UpdateStatus"}]}}},"model.UpdateStatus":{"type":"string","enum":["unchanged","configured","created","deleted","not-found","invalid","error","in-use","forbidden","deprecated"]}}}} ``` ## The model.ResourceTypeOutputOptions object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]}}}} ``` ## The model.ResourceTypeOutputTemplate object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]}}}} ``` ## The model.ResourceTypeOutputTemplateComponentRequirement object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]}}}} ``` ## The model.ResourceTypeOutputTemplateComponentRequirementOperator object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]}}}} ``` ## The model.ResourceTypeSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.DocumentationLink":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string"}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}}}}} ``` ## The model.ResourcesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.ResourcesResponse":{"type":"object","properties":{"resources":{"type":"array","items":{}}}}}}} ``` ## The model.Rollout object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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.Labels":{"type":"object"},"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]}}}} ``` ## The model.RolloutOptions object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"]}}}} ``` ## The model.RolloutProgress object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.RolloutStage object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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.Labels":{"type":"object"},"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"}}}}}} ``` ## The model.RolloutStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.RolloutStatus":{"type":"integer","enum":[0,1,2,3,4,5]}}}} ``` ## The model.Route object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.Routes object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.SetProjectRolePayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.SetProjectRolePayload":{"description":"Body of the request to set a user's project role","type":"object","properties":{"role":{"description":"Role is the new project role for the user (admin, user, or viewer)","allOf":[{"$ref":"#/components/schemas/auth.Role"}]}}},"auth.Role":{"type":"string","enum":["admin","user","viewer","agent",""]}}}} ``` ## The model.Source object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Source":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.SourceResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.SourceResponse":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/model.Source"}}},"model.Source":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.SourceType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.SourceType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.SourceTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.SourceTypeResponse":{"type":"object","properties":{"sourceType":{"$ref":"#/components/schemas/model.SourceType"}}},"model.SourceType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.SourceTypesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.SourceTypesResponse":{"type":"object","properties":{"sourceTypes":{"type":"array","items":{"$ref":"#/components/schemas/model.SourceType"}}}},"model.SourceType":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ResourceTypeSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ResourceTypeSpec":{"type":"object","properties":{"featureGate":{"description":"FeatureGate is a string that is used to gate the availability of this resource type.","type":"string"},"logs":{"description":"individual","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics":{"description":"pairs (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+metrics+traces":{"description":"all three (alphabetical order)","allOf":[{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"}]},"logs+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"metrics+traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"parameters":{"description":"Parameters currently uses the model from stanza. Eventually we will probably create a separate definition for\nBindplane.","type":"array","items":{"$ref":"#/components/schemas/model.ParameterDefinition"}},"supportedLicenseTypes":{"description":"SupportedLicenseTypes is a list of license types that are supported by this resource type. Currently only used for IntegrationTypes.","type":"array","items":{"type":"string"}},"supportedPlatforms":{"description":"SupportedPlatforms is a list of platforms that are supported by this resource type.","type":"array","items":{"type":"string"}},"traces":{"$ref":"#/components/schemas/model.ResourceTypeOutputOptions"},"version":{"type":"string"}}},"model.ResourceTypeOutputOptions":{"type":"object","properties":{"connectors":{"type":"string"},"emits":{"description":"Emits can be used to indicate that a connector emits different kinds of telemetry\nthat it consumes. If empty, it is assumed that the connector emits the same kind of\ntelemetry that it consumes.","type":"array","items":{"$ref":"#/components/schemas/otel.PipelineType"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputTemplate because mapstructure:squash is unmarshal-only","type":"string"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplate"}}}},"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]},"model.ResourceTypeOutputTemplate":{"type":"object","properties":{"connectors":{"type":"string"},"deprecated":{"description":"Deprecations marks component versions where this template becomes deprecated\nExample: To mark pluginreceiver >= v1.84.0 as deprecated:\n deprecated:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"exporters":{"type":"string"},"extensions":{"type":"string"},"match":{"description":"Requirements mark component versions where this template matches\nExample: To mark pluginreceiver >= v1.84.0 as matching:\n match:\n - component: \"github.com/.../receiver/pluginreceiver\"\n operator: \">=\"\n version: \"1.84.0\"","type":"array","items":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirement"}},"processors":{"type":"string"},"receivers":{"description":"These fields are duplicated between here and ResourceTypeOutputOptions because mapstructure:squash is unmarshal-only","type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirement":{"type":"object","properties":{"component":{"type":"string"},"operator":{"$ref":"#/components/schemas/model.ResourceTypeOutputTemplateComponentRequirementOperator"},"version":{"type":"string"}}},"model.ResourceTypeOutputTemplateComponentRequirementOperator":{"type":"string","enum":[">=",">"]},"model.ParameterDefinition":{"type":"object","properties":{"advancedConfig":{"type":"boolean"},"default":{"description":"Must be valid according to Type & ValidValues"},"description":{"type":"string"},"documentation":{"type":"array","items":{"$ref":"#/components/schemas/model.DocumentationLink"}},"hidden":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/components/schemas/model.ParameterOptions"},"properties":{"description":"Properties are parameter specific properties that are not part of the standard\nparameter definition. They are similar to Options, but more flexible because they do\nnot need to be defined for all parameter types.","type":"object","additionalProperties":{}},"relevantIf":{"type":"array","items":{"$ref":"#/components/schemas/model.RelevantIfCondition"}},"required":{"type":"boolean"},"type":{"description":"\"string\", \"int\", \"bool\", \"strings\", \"enum\", or \"extension\"","type":"string"},"validValues":{"description":"only useable if Type == \"enum\"","type":"array","items":{"type":"string"}}}},"model.ParameterOptions":{"type":"object","properties":{"code":{"description":"Code indicates that the parameter should be rendered in a code block.","type":"boolean"},"contexts":{"description":"Contexts lists the OTTL contexts (\"body\", \"attributes\", \"resource\", etc.) the\nper-row dropdown of an ottlFieldRows parameter should offer.","type":"array","items":{"type":"string"}},"creatable":{"description":"Creatable will modify the \"enum\" parameter from a select to\na creatable select where a user can specify a custom value","type":"boolean"},"gridColumns":{"description":"GridColumns will specify the number of flex-grid columns the\ncontrol will take up, must be an integer between 1 and 12 or\nunspecified.","type":"integer"},"horizontalDivider":{"description":"HorizontalDivider will add a horizontal divider after the parameter at full\nwidth of the form.","type":"boolean"},"labels":{"description":"Labels indicate labels that can be used when rendering the parameter. This was added for the \"map\" parameter type\nto make the \"key\" and \"value\" labels configurable.","type":"object","additionalProperties":{"type":"string"}},"metricCategories":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricCategory"}},"multiline":{"description":"Multiline indicates that a multiline textarea should be used for editing a \"string\" parameter.","type":"boolean"},"ottlContext":{"description":"OttlContext indicates which field to use when auto-populating an ottlField parameter.","type":"string"},"ottlContextRef":{"description":"OttlContextRef indicates the name of another parameter whose value determines the OTTL context.\nThis allows a parameter to dynamically resolve its context based on a sibling parameter's value.","type":"string"},"password":{"description":"Password indicates the string field is for a password and will be hidden by the UI.\nOnly applies to string parameters.\nDeprecated, use Sensitive instead.","type":"boolean"},"preventEmpty":{"description":"PreventEmpty indicates that empty values should not be allowed in the parameter.","type":"boolean"},"processorContext":{"description":"ProcessorContext indicates which processor is used to handle the parameter.","type":"string"},"saasOnly":{"description":"SaasOnly indicates that the parameter is only to be shown in a SaaS environment.","type":"boolean"},"sectionHeader":{"description":"SectionHeader is used to indicate that the bool parameter input is\na switch for further configuration for UI styling.","type":"boolean"},"sensitive":{"description":"Sensitive indicates that the field is sensitive and will be masked with (sensitive) in the response.","type":"boolean"},"sensitiveCompanion":{"description":"SensitiveCompanion is the name of a companion parameter that stores sensitive values.\nUsed for map parameters where individual values can be marked as sensitive.","type":"string"},"subHeader":{"description":"SubHeader will place a subheader above the parameter.","type":"string"},"trackUnchecked":{"description":"TrackUnchecked will modify the \"enums\" parameter to store the\nunchecked values as the value.","type":"boolean"},"variant":{"description":"Variant indicates the variant of the input for parameters that support multiple input\ntypes or styles.\n\"condition\" parameter: input can be \"expanded\" or \"collapsed\".\n\"telemetrySelector\" parameter: input can be \"exclusive\", meaning only one value can be selected.","type":"string"}}},"model.MetricCategory":{"type":"object","properties":{"column":{"description":"0 or 1","type":"integer"},"label":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/model.MetricOption"}}}},"model.MetricOption":{"type":"object","properties":{"defaultDisabled":{"type":"boolean"},"description":{"type":"string"},"kpi":{"type":"boolean"},"name":{"type":"string"}}},"model.RelevantIfCondition":{"type":"object","properties":{"name":{"type":"string"},"operator":{"type":"string"},"value":{}}},"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.SourcesResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.SourcesResponse":{"type":"object","properties":{"sources":{"type":"array","items":{"$ref":"#/components/schemas/model.Source"}}}},"model.Source":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.ParameterizedSpec"},"status":{"$ref":"#/components/schemas/model.VersionStatus"}}},"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",""]},"model.ParameterizedSpec":{"type":"object","properties":{"disabled":{"type":"boolean"},"licenseEnabled":{"description":"LicenseEnabled is a flag to indicate if the resource is licensed.","type":"boolean"},"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"},"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.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.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.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The model.Stability object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Stability":{"type":"string","enum":["development","alpha","beta","stable","deprecated",""]}}}} ``` ## The model.TelemetryExample object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.TelemetryExampleEntry object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"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"}}}}}} ``` ## The model.UpdateAccountMetadataPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.UpdateAccountMetadataPayload":{"type":"object","properties":{"displayName":{"type":"string"}}}}}} ``` ## The model.UpdateOrganizationLicenseKeyPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.UpdateOrganizationLicenseKeyPayload":{"type":"object","properties":{"licenseKey":{"type":"string"}}}}}} ``` ## The model.UpdateStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.UpdateStatus":{"type":"string","enum":["unchanged","configured","created","deleted","not-found","invalid","error","in-use","forbidden","deprecated"]}}}} ``` ## The model.User object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.User":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.UserSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.UserSpec":{"type":"object","properties":{"activeAccount":{"type":"string"},"email":{"type":"string"},"nextLoginAccount":{"type":"string"},"requestedMFA":{"description":"RequestedMFA is true if the user has opted-in for multi-factor authentication. This is only supported when Auth0\nis configured as the authentication type.","type":"boolean"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.UserResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.UserResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/model.User"}}},"model.User":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.UserSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.UserSpec":{"type":"object","properties":{"activeAccount":{"type":"string"},"email":{"type":"string"},"nextLoginAccount":{"type":"string"},"requestedMFA":{"description":"RequestedMFA is true if the user has opted-in for multi-factor authentication. This is only supported when Auth0\nis configured as the authentication type.","type":"boolean"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.UserSpec object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.UserSpec":{"type":"object","properties":{"activeAccount":{"type":"string"},"email":{"type":"string"},"nextLoginAccount":{"type":"string"},"requestedMFA":{"description":"RequestedMFA is true if the user has opted-in for multi-factor authentication. This is only supported when Auth0\nis configured as the authentication type.","type":"boolean"}}}}}} ``` ## The model.UsersForOrganizationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.UsersForOrganizationResponse":{"description":"Body of the response to retrieve all users associated with an organization","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/model.User"}}}},"model.User":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.UserSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.UserSpec":{"type":"object","properties":{"activeAccount":{"type":"string"},"email":{"type":"string"},"nextLoginAccount":{"type":"string"},"requestedMFA":{"description":"RequestedMFA is true if the user has opted-in for multi-factor authentication. This is only supported when Auth0\nis configured as the authentication type.","type":"boolean"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.UsersResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.UsersResponse":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/model.User"}}}},"model.User":{"type":"object","properties":{"apiVersion":{"type":"string"},"kind":{"allOf":[{"$ref":"#/components/schemas/model.Kind"}]},"metadata":{"$ref":"#/components/schemas/model.Metadata"},"spec":{"$ref":"#/components/schemas/model.UserSpec"},"status":{"$ref":"#/components/schemas/model.NoStatus"}}},"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",""]},"model.UserSpec":{"type":"object","properties":{"activeAccount":{"type":"string"},"email":{"type":"string"},"nextLoginAccount":{"type":"string"},"requestedMFA":{"description":"RequestedMFA is true if the user has opted-in for multi-factor authentication. This is only supported when Auth0\nis configured as the authentication type.","type":"boolean"}}},"model.NoStatus":{"type":"object"}}}} ``` ## The model.VerifyOrganizationPayload object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.VerifyOrganizationPayload":{"description":"Body of the request to verify an organization name","type":"object","properties":{"name":{"description":"The organization name to verify","type":"string"}}}}}} ``` ## The model.VerifyOrganizationResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.VerifyOrganizationResponse":{"description":"Body of the response to verify an organization name","type":"object","properties":{"valid":{"type":"boolean"}}}}}} ``` ## The model.Version object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.Version":{"type":"integer","enum":[-2,-1,0]}}}} ``` ## The model.VersionStatus object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"model.VersionStatus":{"type":"object","properties":{"latest":{"type":"boolean"}}}}}} ``` ## The otel.PipelineType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"otel.PipelineType":{"type":"string","enum":["metrics","logs","traces"]}}}} ``` ## The parameters.PhaseAgentCountType object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"parameters.PhaseAgentCountType":{"type":"string","enum":["adaptive","custom","small","medium","large","xl","xxl"]}}}} ``` ## The rest.ErrorResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"rest.ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The rest.healthEventBusResponse object ```json {"openapi":"3.1.1","info":{"title":"","version":"0.0.1"},"components":{"schemas":{"rest.healthEventBusResponse":{"type":"object","properties":{"healthy":{"type":"boolean"},"hosts":{"type":"array","items":{"type":"string"}}}}}}} ``` --- # Agent Instructions: 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/models.md?ask= ``` 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.