Add Notes To Artifacts‎ | docs.d3security

POST /Command/AddNotesToArtifacts

Add notes to artifacts

Request

Authentication: API keys or JSON web tokens (JWT)

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Artifact Name	`string`	Required	The name of the artifact
Artifact Type	`integer`	Optional	Artifact type
Note	`string`	Required	A note will be added to the input artifact

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Artifact Name": "D3CYBER-DC",
    "Artifact Type": "Internal Endpoint",
    "Note": "Notes sample text"
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
result	`string`	The result data from the API request.
error	`string`	The error message if the command execution failed.
returnData	`string`	The return data from the API request.
contextData	`array<JSON Object>`	The context data from the API request.

Sample Data

JSON

{
    "result": "<table class='cc-table horizontal-table'><tr><td>D3CYBER-DC</td><td>Internal Endpoint</td><td>Notes sample text</td><td>02/08/2024 15:17</td><td>Successful</td></tr></table>",
    "error": "",
    "returnData": "Successful",
    "contextData": [
        {
            "Artifact Name": "D3CYBER-DC",
            "Artifact Type": "Internal Endpoint",
            "Note": "Notes sample text",
            "LastModifiedLocalDate": "01/26/2022 09:42 PM",
            "Result": "Successful"
        }
    ]
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}