Ctrlk
BlogSupport
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Remote Repository

APIs for remote repository management

Install content on a production tenant

post

After the new content is ready and committed to the development tenant, you can install it on the production tenant by using the output from Check for new content API as the input in this API.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
idstringOptional
versionintegerOptional
cacheVersnintegerOptional
sequenceNumberintegerOptional
primaryTermintegerOptional
modifiedstringOptional
sizeInBytesintegerOptional
sortValuesstring[]Optional
hashLateststringOptional
releaseNotesstringOptional
releaseDatestringOptional
releasestringOptional
assetIdintegerOptional
installDatestringOptional
ignoreGitbooleanOptional
manualbooleanOptional
gitIdintegerOptional
ForcebooleanOptional
Responses
200

OK

application/json
objectOptional
post/xsoar/public/v1/content/install
POST /xsoar/public/v1/content/install HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 744

{
  "id": "c8084ef2151241e28f03e65beb40704f",
  "version": 1,
  "cacheVersn": 0,
  "sequenceNumber": 23777651,
  "primaryTerm": 4,
  "modified": "2024-04-09T07:36:51.875190701Z",
  "sizeInBytes": 638,
  "sortValues": [
    "1712648211875"
  ],
  "hashLatest": "8aac48ad29724738eb3f05598955b453e77869e3",
  "releaseNotes": "## Release Notes for version 2024.04.09.065950\n##### Published on Tue, 09 Apr 2024 06:59:50 UTC (8aac48ad29724738eb3f05598955b453e77869e3)\n### Playbooks\n__new_uncommitted__\n- No commit message\n\n__api_test__\n- No commit message\n### Incident Fields\n__Asset Table__\n- No commit message\n",
  "releaseDate": "2024-04-09T06:59:50Z",
  "release": "2024.04.09.065950",
  "assetId": 0,
  "installDate": "0001-01-01T00:00:00Z",
  "ignoreGit": false,
  "manual": false,
  "gitId": 0,
  "Force": false
}
200

OK

{}

Check for new content

post

Check what new content has been pushed from the development tenant and are available to be installed or updated on the production tenant. All new content is returned in the response and you can verify that the content you expect to see there exists.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
objectOptional
Responses
200

OK

application/json
idstringOptional
versionintegerOptional
cacheVersnintegerOptional
sequenceNumberintegerOptional
primaryTermintegerOptional
modifiedstringOptional
sizeInBytesintegerOptional
hashLateststringOptional
releaseNotesstringOptional
releaseDatestringOptional
releasestringOptional
assetIdintegerOptional
installDatestringOptional
ignoreGitbooleanOptional
manualbooleanOptional
gitIdintegerOptional
ForcebooleanOptional
post/xsoar/public/v1/content/checkNew
POST /xsoar/public/v1/content/checkNew HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

OK

{
  "id": "a68eb260e9884f1a8110816d15c3b6d9",
  "version": 1,
  "cacheVersn": 0,
  "sequenceNumber": 25114099,
  "primaryTerm": 4,
  "modified": "2024-04-24T06:35:16.279682561Z",
  "sizeInBytes": 729,
  "hashLatest": "efa3533e9cb43f2d25eef573440c25eac6d38911",
  "releaseNotes": "## Release Notes for version 2024.04.24.063055\n##### Published on Wed, 24 Apr 2024 06:30:55 UTC (efa3533e9cb43f2d25eef573440c25eac6d38911)\n### Playbooks\n__new_maya_test__\n- No commit message\n### Indicator Fields\n__Name__\n- Install pack Common Types at version 3.4.10\n### Pre-Process Rules\n__linked_rules__\n- Content import\n### Lists\n__Sharon's list__\n- No commit message\n",
  "releaseDate": "2024-04-24T06:30:55Z",
  "release": "2024.04.24.063055",
  "assetId": 0,
  "installDate": "0001-01-01T00:00:00Z",
  "ignoreGit": false,
  "manual": false,
  "gitId": 0,
  "Force": false
}

Get a list of content available to be pushed to production

get

Get a list of custom content that is available on the development tenant to be pushed to the production tenant.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Responses
200

OK

application/json
namestringOptional
filenamestringOptional
typestringOptional
actionstringOptional
messagestringOptional
authorNamestringOptional
authorEmailstringOptional
whenstringOptional
commitHashstringOptional
committerNamestringOptional
isCommittedbooleanOptional

Whether the content is committed.

isSystembooleanOptional
packIDstringOptional
subTypestringOptional
excludebooleanOptional

Whether this content is excluded.

get/xsoar/public/v1/vc/changes/uncommitted
GET /xsoar/public/v1/vc/changes/uncommitted HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Accept: */*
200

OK

[
  {
    "name": "john_copy_1",
    "filename": "playbook/playbook-john_copy_1.yml",
    "type": "playbook",
    "action": "Insert",
    "message": "Content import",
    "authorName": "jdoe",
    "authorEmail": "user@company.com",
    "when": "2024-04-09T08:48:49.855374957Z",
    "exclude": true
  },
  {
    "name": "new_john_test",
    "filename": "playbook/playbook-new_john_test.yml",
    "type": "playbook",
    "action": "Insert",
    "authorName": "jdoe",
    "authorEmail": "user@company.com",
    "when": "2024-04-24T06:14:14.25749347Z"
  },
  {
    "name": "john_dev_field1",
    "filename": "incidentfield/incidentfield-john_dev_field1.json",
    "type": "incidentfield",
    "action": "Insert",
    "message": "Content import",
    "authorName": "jdoe",
    "authorEmail": "user@company.com",
    "when": "2024-04-09T08:48:51.060027034Z"
  }
]

Push custom content to production tenant

post

Use the response from Get a list of content available to be pushed to production to customize what content you want to push to the production tenant. Use that customized content as the request in this API. Once this is performed successfully, that content should no longer appear when running Get a list of content available to be pushed to production.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
messagestringOptional
validateDependenciesbooleanOptional
Responses
200

OK

application/json
namestringOptional
filenamestringOptional
typestringOptional
actionstringOptional
messagestringOptional
authorNamestringOptional
authorEmailstringOptional
whenstringOptional
isSystembooleanOptional
packIDstringOptional
post/xsoar/public/v1/vc/changes/uncommitted/commit
POST /xsoar/public/v1/vc/changes/uncommitted/commit HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "message": "",
  "changes": [
    {
      "name": "new_john_test",
      "filename": "playbook/playbook-new_ohn_test.yml",
      "type": "playbook",
      "action": "Insert",
      "authorName": "jdoe",
      "authorEmail": "user@company.com",
      "when": "2024-04-24T06:14:14.25749347Z"
    }
  ],
  "validateDependencies": true
}
200

OK

[
  {
    "name": " Cortex XDR Disconnected Endpoints",
    "filename": "widget/widget-0361981e-c627-4c09-8fcc-085ffe0a7e56-Cortex_XDR_Disconnected_Endpoints.json",
    "type": "widget",
    "action": "Insert",
    "message": "Install pack Cortex XDR by Palo Alto Networks at version 6.1.28",
    "authorName": "John Doe",
    "authorEmail": "user@company.com",
    "when": "2024-04-21T13:25:15.709207541Z",
    "isSystem": true,
    "packID": "CortexXDR"
  },
  {
    "name": "120",
    "filename": "playbook/playbook-120.yml",
    "type": "playbook",
    "action": "Insert",
    "message": "Content import",
    "authorName": "Jane Doe",
    "authorEmail": "user1@company.com",
    "when": "2024-04-09T08:48:45.619770656Z"
  },
  {
    "name": "120_copy",
    "filename": "playbook/playbook-120_copy.yml",
    "type": "playbook",
    "action": "Insert",
    "message": "Content import",
    "authorName": "Jane Doe",
    "authorEmail": "user1@company.com",
    "when": "2024-04-09T08:48:45.719423579Z"
  },
  {
    "name": "API Execution Metrics",
    "filename": "dashboard/dashboard-API_Execution_Metrics-API_Execution_Metrics.json",
    "type": "dashboard",
    "action": "Modify",
    "message": "Install pack Common Dashboards at version 1.4.1",
    "authorName": "DBot",
    "authorEmail": "DBot@demisto.com",
    "when": "2024-04-09T07:58:26.168618437Z",
    "isSystem": true,
    "packID": "CommonDashboards"
  }
]
PreviousPlaybooks
NextReports

Last updated

Was this helpful?