This section outlines the key attributes of the org's API object. This object can be utilized through the API, CLI and the console's apply functionality.
id string
name string
Max Length: 64
kind string
version integer
description string
Max Length: 250
tags object
created string
Format: date-time
lastModified string
Format: date-time
links array of objects
- See Below
spec object
- See Below
status object
- See Below
rel string
href string
logging object
- See Below
extraLogging array of objects
- See Below
tracing object
- See Below
sessionTimeoutSeconds number
authConfig object
- See Below
observability object
- See Below
s3 object
- See Below
coralogix object
- See Below
datadog object
- See Below
logzio object
- See Below
elastic object
- See Below
cloudWatch object
- See Below
fluentd object
- See Below
stackdriver object
- See Below
bucket string
region string
prefix string
Default: /
credentials string
cluster string
Possible enum values:
coralogix.com
coralogix.us
app.coralogix.in
app.eu2.coralogix.com
app.coralogixsg.com
credentials string
app string
subsystem string
host string
Possible enum values:
http-intake.logs.datadoghq.com
http-intake.logs.us3.datadoghq.com
http-intake.logs.us5.datadoghq.com
http-intake.logs.datadoghq.eu
credentials string
listenerHost string
Possible enum values:
listener.logz.io
listener-nl.logz.io
credentials string
aws object
- See Below
elasticCloud object
- See Below
generic object
- See Below
host string
port integer
index string
type string
credentials string
region string
index string
type string
credentials string
cloudId string
host string
port integer
path string
index string
type string
credentials string
username string
password string
region string
Possible enum values:
us-east-1
us-east-2
us-west-1
us-west-2
ap-south-1
ap-northeast-2
ap-southeast-1
ap-southeast-2
ap-northeast-1
eu-central-1
eu-west-1
eu-west-2
eu-south-1
eu-west-3
eu-north-1
me-south-1
sa-east-1
af-south-1
credentials string
retentionDays integer
groupName string
streamName string
host string
port integer
credentials string
location string
Possible enum values:
us-east1
us-east4
us-central1
us-west1
europe-west4
europe-west1
europe-west3
europe-west2
asia-east1
asia-southeast1
asia-northeast1
asia-south1
australia-southeast1
southamerica-east1
africa-south1
asia-east2
asia-northeast2
asia-northeast3
asia-south2
asia-southeast2
australia-southeast2
europe-central2
europe-north1
europe-southwest1
europe-west10
europe-west12
europe-west6
europe-west8
europe-west9
me-central1
me-central2
me-west1
northamerica-northeast1
northamerica-northeast2
southamerica-west1
us-east5
us-south1
us-west2
us-west3
us-west4
s3 object
- See Below
coralogix object
- See Below
datadog object
- See Below
logzio object
- See Below
elastic object
- See Below
cloudWatch object
- See Below
fluentd object
- See Below
stackdriver object
- See Below
sampling number
lightstep object
- See Below
customTags object
provider object
- See Below
endpoint string
credentials string
otel object
- See Below
lightstep object
- See Below
endpoint string
domainAutoMembers array of strings
samlOnly boolean
logsRetentionDays integer
metricsRetentionDays integer
tracesRetentionDays integer
accountLink string
active boolean