org
Perform a Patch on an org by name
Overview
agent
auditctx
cloudaccount
- GETGet a cloud account by name
- DELDelete an cloud account by name
- PATCHPerform a Patch on a cloud account by name
- GETGet all cloud accounts
- POSTCreate a cloud account
- POSTGet all cloud accounts based on a query
- GETGet the access report for a cloud account by name
- GETGet available permissions for a cloud account resource type
domain
group
gvc
identity
- GETGet an identity by GVC and name
- DELDelete an identity by GVC and name
- PATCHPerform a Patch on an identity by name
- GETGet all identities in a GVC
- POSTCreate an identity
- GETGet all identities from all GVCs
- POSTGet all GVC identities based on a query
- GETGet the access report for an identity by GVC and name
- GETGet available permissions for an identity
image
location
org
policy
quota
secret
- GETGet a secret by name
- DELDelete a secret by name
- PATCHPerform a Patch on a secret by name
- GETGet all secrets
- POSTCreate a secret
- GETGet the sensitive content of a secret by name
- POSTGet all secrets based on a query
- GETGet the access report for a secret by name
- GETGet available permissions for a secret resource type
serviceaccount
- GETGet a service account by name
- DELDelete a service account by name
- PATCHPerform a Patch on a service account by name
- GETGet all service accounts
- POSTCreate a service account
- POSTGet all service accounts based on a query
- GETGet the access report for a service account by name
- POSTAdd a key to a service account
- GETGet available permissions for a service account resource type
task
user
volumeset
- GETGet a volumeset by GVC and name
- DELDelete a volumeset by name
- PATCHPerform a Patch on a volumeset by name
- GETList volumesets in a GVC you are authorized to view
- POSTCreate a volumeset
- GETGet all volumesets
- POSTGet all volumesets based on a query
- GETGet the access report for a volumeset by GVC and name
- GETGet available permissions for a volumeset resource type
workload
- GETGet a workload by GVC and name
- DELDelete a workload by name
- PATCHPerform a Patch on a workload by name
- GETGet a deployment by GVC, workload and name
- GETList workloads in a GVC you are authorized to view
- POSTCreate a workload
- GETGet all workloads
- GETList deployments in a workload
- POSTGet all workloads based on a query
- GETGet the access report for a workload by GVC and name
- GETGet available permissions for a workload resource type
org
Perform a Patch on an org by name
PATCH
/
org
/
{name}
Authorization
string
*
Authorization
Required
string
Service account key can be used as API keys
name
string
*
name
Required
string
object
$drop
array
$drop
array
description
string
description
string
tags
object
tags
object
$replace/tags
object
$replace/tags
object
spec
object
spec
object
$drop
array
$drop
array
logging
object
logging
object
$drop
array
$drop
array
s3
object
s3
object
$drop
array
$drop
array
bucket
string
bucket
string
region
string
region
string
prefix
string
prefix
string
credentials
string
credentials
string
$replace/s3
object
$replace/s3
object
bucket
string
bucket
string
region
string
region
string
prefix
string
prefix
string
credentials
string
credentials
string
coralogix
object
coralogix
object
$drop
array
$drop
array
cluster
enum<string>
cluster
enum<string>
credentials
string
credentials
string
app
string
app
string
subsystem
string
subsystem
string
$replace/coralogix
object
$replace/coralogix
object
cluster
enum<string>
cluster
enum<string>
credentials
string
credentials
string
app
string
app
string
subsystem
string
subsystem
string
datadog
object
datadog
object
$drop
array
$drop
array
host
enum<string>
host
enum<string>
credentials
string
credentials
string
$replace/datadog
object
$replace/datadog
object
host
enum<string>
host
enum<string>
credentials
string
credentials
string
logzio
object
logzio
object
$drop
array
$drop
array
listenerHost
enum<string>
listenerHost
enum<string>
credentials
string
credentials
string
$replace/logzio
object
$replace/logzio
object
listenerHost
enum<string>
listenerHost
enum<string>
credentials
string
credentials
string
elastic
object
elastic
object
$drop
array
$drop
array
aws
object
aws
object
$replace/aws
object
$replace/aws
object
elasticCloud
object
elasticCloud
object
$replace/elasticCloud
object
$replace/elasticCloud
object
generic
object
generic
object
$replace/generic
object
$replace/generic
object
$replace/elastic
object
$replace/elastic
object
aws
object
aws
object
elasticCloud
object
elasticCloud
object
generic
object
generic
object
cloudWatch
object
cloudWatch
object
$drop
array
$drop
array
region
enum<string>
region
enum<string>
credentials
string
credentials
string
retentionDays
integer
retentionDays
integer
groupName
string
groupName
string
streamName
string
streamName
string
extractFields
object
extractFields
object
$replace/extractFields
object
$replace/extractFields
object
$replace/cloudWatch
object
$replace/cloudWatch
object
region
enum<string>
region
enum<string>
credentials
string
credentials
string
retentionDays
integer
retentionDays
integer
groupName
string
groupName
string
streamName
string
streamName
string
extractFields
object
extractFields
object
fluentd
object
fluentd
object
$drop
array
$drop
array
host
string
host
string
port
integer
port
integer
$replace/fluentd
object
$replace/fluentd
object
host
string
host
string
port
integer
port
integer
stackdriver
object
stackdriver
object
$drop
array
$drop
array
credentials
string
credentials
string
location
enum<string>
location
enum<string>
$replace/stackdriver
object
$replace/stackdriver
object
credentials
string
credentials
string
location
enum<string>
location
enum<string>
syslog
object
syslog
object
$drop
array
$drop
array
host
string
host
string
port
integer
port
integer
mode
enum<string>
mode
enum<string>
format
enum<string>
format
enum<string>
severity
number
severity
number
Emergency (EMERG) (severity level 0): System is unusable.
Alert (ALERT) (severity level 1): Action must be taken immediately.
Critical (CRIT) (severity level 2): Critical conditions.
Error (ERR) (severity level 3): Error conditions.
Warning (WARNING) (severity level 4): Warning conditions.
Notice (NOTICE) (severity level 5): Normal but significant conditions.
Informational (INFO) (severity level 6): Informational messages.
Debug (DEBUG) (severity level 7): Debug-level messages.
$replace/syslog
object
$replace/syslog
object
host
string
host
string
port
integer
port
integer
mode
enum<string>
mode
enum<string>
format
enum<string>
format
enum<string>
severity
number
severity
number
Emergency (EMERG) (severity level 0): System is unusable.
Alert (ALERT) (severity level 1): Action must be taken immediately.
Critical (CRIT) (severity level 2): Critical conditions.
Error (ERR) (severity level 3): Error conditions.
Warning (WARNING) (severity level 4): Warning conditions.
Notice (NOTICE) (severity level 5): Normal but significant conditions.
Informational (INFO) (severity level 6): Informational messages.
Debug (DEBUG) (severity level 7): Debug-level messages.
$replace/logging
object
$replace/logging
object
s3
object
s3
object
bucket
string
bucket
string
region
string
region
string
prefix
string
prefix
string
credentials
string
credentials
string
coralogix
object
coralogix
object
cluster
enum<string>
cluster
enum<string>
credentials
string
credentials
string
app
string
app
string
subsystem
string
subsystem
string
datadog
object
datadog
object
host
enum<string>
host
enum<string>
credentials
string
credentials
string
logzio
object
logzio
object
listenerHost
enum<string>
listenerHost
enum<string>
credentials
string
credentials
string
elastic
object
elastic
object
aws
object
aws
object
elasticCloud
object
elasticCloud
object
generic
object
generic
object
cloudWatch
object
cloudWatch
object
region
enum<string>
region
enum<string>
credentials
string
credentials
string
retentionDays
integer
retentionDays
integer
groupName
string
groupName
string
streamName
string
streamName
string
extractFields
object
extractFields
object
fluentd
object
fluentd
object
host
string
host
string
port
integer
port
integer
stackdriver
object
stackdriver
object
credentials
string
credentials
string
location
enum<string>
location
enum<string>
syslog
object
syslog
object
host
string
host
string
port
integer
port
integer
mode
enum<string>
mode
enum<string>
format
enum<string>
format
enum<string>
severity
number
severity
number
Emergency (EMERG) (severity level 0): System is unusable.
Alert (ALERT) (severity level 1): Action must be taken immediately.
Critical (CRIT) (severity level 2): Critical conditions.
Error (ERR) (severity level 3): Error conditions.
Warning (WARNING) (severity level 4): Warning conditions.
Notice (NOTICE) (severity level 5): Normal but significant conditions.
Informational (INFO) (severity level 6): Informational messages.
Debug (DEBUG) (severity level 7): Debug-level messages.
extraLogging
array
extraLogging
array
$drop/extraLogging
array
$drop/extraLogging
array
$append/extraLogging
array
$append/extraLogging
array
$patch/extraLogging
array
$patch/extraLogging
array
$retain/extraLogging
array
$retain/extraLogging
array
tracing
object
tracing
object
$drop
array
$drop
array
sampling
number
sampling
number
lightstep
object
lightstep
object
$drop
array
$drop
array
endpoint
string
endpoint
string
credentials
string
credentials
string
$replace/lightstep
object
$replace/lightstep
object
endpoint
string
endpoint
string
credentials
string
credentials
string
customTags
object
customTags
object
$replace/customTags
object
$replace/customTags
object
provider
object
provider
object
$drop
array
$drop
array
otel
object
otel
object
$replace/otel
object
$replace/otel
object
lightstep
object
lightstep
object
$replace/lightstep
object
$replace/lightstep
object
controlplane
object
controlplane
object
$replace/controlplane
object
$replace/controlplane
object
$replace/provider
object
$replace/provider
object
otel
object
otel
object
lightstep
object
lightstep
object
controlplane
object
controlplane
object
$replace/tracing
object
$replace/tracing
object
sampling
number
sampling
number
lightstep
object
lightstep
object
endpoint
string
endpoint
string
credentials
string
credentials
string
customTags
object
customTags
object
provider
object
provider
object
otel
object
otel
object
lightstep
object
lightstep
object
controlplane
object
controlplane
object
sessionTimeoutSeconds
number
sessionTimeoutSeconds
number
authConfig
object
authConfig
object
$drop
array
$drop
array
domainAutoMembers
array
domainAutoMembers
array
$drop/domainAutoMembers
array
$drop/domainAutoMembers
array
$append/domainAutoMembers
array
$append/domainAutoMembers
array
$retain/domainAutoMembers
array
$retain/domainAutoMembers
array
samlOnly
boolean
samlOnly
boolean
$replace/authConfig
object
$replace/authConfig
object
domainAutoMembers
array
domainAutoMembers
array
samlOnly
boolean
samlOnly
boolean
observability
object
observability
object
$drop
array
$drop
array
logsRetentionDays
integer
logsRetentionDays
integer
metricsRetentionDays
integer
metricsRetentionDays
integer
tracesRetentionDays
integer
tracesRetentionDays
integer
$replace/observability
object
$replace/observability
object
logsRetentionDays
integer
logsRetentionDays
integer
metricsRetentionDays
integer
metricsRetentionDays
integer
tracesRetentionDays
integer
tracesRetentionDays
integer
security
object
security
object
$drop
array
$drop
array
threatDetection
object
threatDetection
object
$drop
array
$drop
array
enabled
boolean
enabled
boolean
whether or not detected threats should be forwarded
minimumSeverity
enum<string>
minimumSeverity
enum<string>
any threats with this severity and more severe will be sent. Others will be ignored
syslog
object
syslog
object
$replace/syslog
object
$replace/syslog
object
configuration for syslog forwarding
$replace/threatDetection
object
$replace/threatDetection
object
configure detected threats to be forwarded using a specified protocol
enabled
boolean
enabled
boolean
whether or not detected threats should be forwarded
minimumSeverity
enum<string>
minimumSeverity
enum<string>
any threats with this severity and more severe will be sent. Others will be ignored
syslog
object
syslog
object
configuration for syslog forwarding
$replace/security
object
$replace/security
object
threatDetection
object
threatDetection
object
configure detected threats to be forwarded using a specified protocol
enabled
boolean
enabled
boolean
whether or not detected threats should be forwarded
minimumSeverity
enum<string>
minimumSeverity
enum<string>
any threats with this severity and more severe will be sent. Others will be ignored
syslog
object
syslog
object
configuration for syslog forwarding
$replace/spec
object
$replace/spec
object
logging
object
logging
object
s3
object
s3
object
bucket
string
bucket
string
region
string
region
string
prefix
string
prefix
string
credentials
string
credentials
string
coralogix
object
coralogix
object
cluster
enum<string>
cluster
enum<string>
credentials
string
credentials
string
app
string
app
string
subsystem
string
subsystem
string
datadog
object
datadog
object
host
enum<string>
host
enum<string>
credentials
string
credentials
string
logzio
object
logzio
object
listenerHost
enum<string>
listenerHost
enum<string>
credentials
string
credentials
string
elastic
object
elastic
object
aws
object
aws
object
elasticCloud
object
elasticCloud
object
generic
object
generic
object
cloudWatch
object
cloudWatch
object
region
enum<string>
region
enum<string>
credentials
string
credentials
string
retentionDays
integer
retentionDays
integer
groupName
string
groupName
string
streamName
string
streamName
string
extractFields
object
extractFields
object
fluentd
object
fluentd
object
host
string
host
string
port
integer
port
integer
stackdriver
object
stackdriver
object
credentials
string
credentials
string
location
enum<string>
location
enum<string>
syslog
object
syslog
object
host
string
host
string
port
integer
port
integer
mode
enum<string>
mode
enum<string>
format
enum<string>
format
enum<string>
severity
number
severity
number
Emergency (EMERG) (severity level 0): System is unusable.
Alert (ALERT) (severity level 1): Action must be taken immediately.
Critical (CRIT) (severity level 2): Critical conditions.
Error (ERR) (severity level 3): Error conditions.
Warning (WARNING) (severity level 4): Warning conditions.
Notice (NOTICE) (severity level 5): Normal but significant conditions.
Informational (INFO) (severity level 6): Informational messages.
Debug (DEBUG) (severity level 7): Debug-level messages.
extraLogging
array
extraLogging
array
tracing
object
tracing
object
sampling
number
sampling
number
lightstep
object
lightstep
object
endpoint
string
endpoint
string
credentials
string
credentials
string
customTags
object
customTags
object
provider
object
provider
object
otel
object
otel
object
lightstep
object
lightstep
object
controlplane
object
controlplane
object
sessionTimeoutSeconds
number
sessionTimeoutSeconds
number
authConfig
object
authConfig
object
domainAutoMembers
array
domainAutoMembers
array
samlOnly
boolean
samlOnly
boolean
observability
object
observability
object
logsRetentionDays
integer
logsRetentionDays
integer
metricsRetentionDays
integer
metricsRetentionDays
integer
tracesRetentionDays
integer
tracesRetentionDays
integer
security
object
security
object
threatDetection
object
threatDetection
object
configure detected threats to be forwarded using a specified protocol
enabled
boolean
enabled
boolean
whether or not detected threats should be forwarded
minimumSeverity
enum<string>
minimumSeverity
enum<string>
any threats with this severity and more severe will be sent. Others will be ignored
syslog
object
syslog
object
configuration for syslog forwarding
Authorizations
Authorization
string
headerrequiredService account key can be used as API keys
Path Parameters
name
string
requiredBody
application/json
$drop
enum<string>[]
Available options:
description, tags, spec description
string
Maximum length:
250tags
object
$replace/tags
object
spec
object
$replace/spec
object
Response
200 - application/json
id
string
kind
string
version
integer
description
string
Maximum length:
250tags
object
created
string
lastModified
string
links
object[]
name
string
Maximum length:
64spec
object
status
object