POST https://api.ap1.datadoghq.com/api/v2/agentless_scanning/accounts/aws https://api.ap2.datadoghq.com/api/v2/agentless_scanning/accounts/aws https://api.datadoghq.eu/api/v2/agentless_scanning/accounts/aws https://api.ddog-gov.com/api/v2/agentless_scanning/accounts/aws https://api.us2.ddog-gov.com/api/v2/agentless_scanning/accounts/aws https://api.datadoghq.com/api/v2/agentless_scanning/accounts/aws https://api.us3.datadoghq.com/api/v2/agentless_scanning/accounts/aws https://api.us5.datadoghq.com/api/v2/agentless_scanning/accounts/aws
Overview Activate Agentless scan options for an AWS account.
OAuth apps require the org_management authorization scope to access this endpoint.
Request Body Data (required) The definition of the new scan options.
Expand All
Object for the scan options of a single AWS account.
Attributes for the AWS scan options to create.
compliance_host [required ]
Indicates whether host compliance scanning is enabled.
Indicates if scanning of Lambda functions is enabled.
sensitive_data [required ]
Indicates if scanning for sensitive data is enabled.
vuln_containers_os [required ]
Indicates if scanning for vulnerabilities in containers is enabled.
Indicates if scanning for vulnerabilities in hosts is enabled.
The ID of the AWS account.
The type of the resource. The value should always be aws_scan_options.
Allowed enum values: aws_scan_options
default: aws_scan_options
{
"data" : {
"attributes" : {
"compliance_host" : false ,
"lambda" : true ,
"sensitive_data" : false ,
"vuln_containers_os" : true ,
"vuln_host_os" : true
},
"id" : "123456789012" ,
"type" : "aws_scan_options"
}
} Response Agentless scan options enabled successfully.
Response object that includes the scan options of an AWS account.
Expand All
Single AWS Scan Options entry.
Attributes for the AWS scan options.
Indicates whether host compliance scanning is enabled.
Indicates if scanning of Lambda functions is enabled.
Indicates if scanning for sensitive data is enabled.
Indicates if scanning for vulnerabilities in containers is enabled.
Indicates if scanning for vulnerabilities in hosts is enabled.
The ID of the AWS account.
The type of the resource. The value should always be aws_scan_options.
Allowed enum values: aws_scan_options
default: aws_scan_options
{
"data" : {
"attributes" : {
"compliance_host" : false ,
"lambda" : true ,
"sensitive_data" : false ,
"vuln_containers_os" : true ,
"vuln_host_os" : true
},
"id" : "184366314700" ,
"type" : "aws_scan_options"
}
} Bad Request
{
"errors" : [
"Bad Request"
]
} Not Authorized
{
"errors" : [
"Bad Request"
]
} Conflict
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
## default
#
# Curl command curl -X POST "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/agentless_scanning/accounts/aws " \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"data": {
"attributes": {
"compliance_host": false,
"lambda": true,
"sensitive_data": false,
"vuln_containers_os": true,
"vuln_host_os": true
},
"id": "123456789012",
"type": "aws_scan_options"
}
}
EOF
"""
Create AWS scan options returns "Agentless scan options enabled successfully." response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
from datadog_api_client.v2.model.aws_scan_options_create_attributes import AwsScanOptionsCreateAttributes
from datadog_api_client.v2.model.aws_scan_options_create_data import AwsScanOptionsCreateData
from datadog_api_client.v2.model.aws_scan_options_create_request import AwsScanOptionsCreateRequest
from datadog_api_client.v2.model.aws_scan_options_type import AwsScanOptionsType
body = AwsScanOptionsCreateRequest (
data = AwsScanOptionsCreateData (
id = "000000000003" ,
type = AwsScanOptionsType . AWS_SCAN_OPTIONS ,
attributes = AwsScanOptionsCreateAttributes (
compliance_host = True ,
_lambda = True ,
sensitive_data = False ,
vuln_containers_os = True ,
vuln_host_os = True ,
),
),
)
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = AgentlessScanningApi ( api_client )
response = api_instance . create_aws_scan_options ( body = body )
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Create AWS scan options returns "Agentless scan options enabled successfully." response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: AgentlessScanningAPI . new
body = DatadogAPIClient :: V2 :: AwsScanOptionsCreateRequest . new ({
data : DatadogAPIClient :: V2 :: AwsScanOptionsCreateData . new ({
id : "000000000003" ,
type : DatadogAPIClient :: V2 :: AwsScanOptionsType :: AWS_SCAN_OPTIONS ,
attributes : DatadogAPIClient :: V2 :: AwsScanOptionsCreateAttributes . new ({
compliance_host : true ,
lambda : true ,
sensitive_data : false ,
vuln_containers_os : true ,
vuln_host_os : true ,
}),
}),
})
p api_instance . create_aws_scan_options ( body )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Create AWS scan options returns "Agentless scan options enabled successfully." response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main () {
body := datadogV2 . AwsScanOptionsCreateRequest {
Data : datadogV2 . AwsScanOptionsCreateData {
Id : "000000000003" ,
Type : datadogV2 . AWSSCANOPTIONSTYPE_AWS_SCAN_OPTIONS ,
Attributes : datadogV2 . AwsScanOptionsCreateAttributes {
ComplianceHost : true ,
Lambda : true ,
SensitiveData : false ,
VulnContainersOs : true ,
VulnHostOs : true ,
},
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewAgentlessScanningApi ( apiClient )
resp , r , err := api . CreateAwsScanOptions ( ctx , body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `AgentlessScanningApi.CreateAwsScanOptions`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `AgentlessScanningApi.CreateAwsScanOptions`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Create AWS scan options returns "Agentless scan options enabled successfully." response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.AgentlessScanningApi ;
import com.datadog.api.client.v2.model.AwsScanOptionsCreateAttributes ;
import com.datadog.api.client.v2.model.AwsScanOptionsCreateData ;
import com.datadog.api.client.v2.model.AwsScanOptionsCreateRequest ;
import com.datadog.api.client.v2.model.AwsScanOptionsResponse ;
import com.datadog.api.client.v2.model.AwsScanOptionsType ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
AgentlessScanningApi apiInstance = new AgentlessScanningApi ( defaultClient );
AwsScanOptionsCreateRequest body =
new AwsScanOptionsCreateRequest ()
. data (
new AwsScanOptionsCreateData ()
. id ( "000000000003" )
. type ( AwsScanOptionsType . AWS_SCAN_OPTIONS )
. attributes (
new AwsScanOptionsCreateAttributes ()
. complianceHost ( true )
. lambda ( true )
. sensitiveData ( false )
. vulnContainersOs ( true )
. vulnHostOs ( true )));
try {
AwsScanOptionsResponse result = apiInstance . createAwsScanOptions ( body );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling AgentlessScanningApi#createAwsScanOptions" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Create AWS scan options returns "Agentless scan options enabled successfully."
// response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_agentless_scanning ::AgentlessScanningAPI ;
use datadog_api_client ::datadogV2 ::model ::AwsScanOptionsCreateAttributes ;
use datadog_api_client ::datadogV2 ::model ::AwsScanOptionsCreateData ;
use datadog_api_client ::datadogV2 ::model ::AwsScanOptionsCreateRequest ;
use datadog_api_client ::datadogV2 ::model ::AwsScanOptionsType ;
#[tokio::main]
async fn main () {
let body = AwsScanOptionsCreateRequest ::new ( AwsScanOptionsCreateData ::new (
AwsScanOptionsCreateAttributes ::new ( true , true , false , true , true ),
"000000000003" . to_string (),
AwsScanOptionsType ::AWS_SCAN_OPTIONS ,
));
let configuration = datadog ::Configuration ::new ();
let api = AgentlessScanningAPI ::with_config ( configuration );
let resp = api . create_aws_scan_options ( body ). await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Create AWS scan options returns "Agentless scan options enabled successfully." response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . AgentlessScanningApi ( configuration );
const params : v2.AgentlessScanningApiCreateAwsScanOptionsRequest = {
body : {
data : {
id : "000000000003" ,
type : "aws_scan_options" ,
attributes : {
complianceHost : true ,
lambda : true ,
sensitiveData : false ,
vulnContainersOs : true ,
vulnHostOs : true ,
},
},
},
};
apiInstance
. createAwsScanOptions ( params )
. then (( data : v2.AwsScanOptionsResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"