Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The servers The connections API provides functionality that allows a an administrator to perform actions such as adding and configuring a server to connection to crawl, or beginning or stopping a crawl

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Section

Get all

servers

connections

Lists all the servers connections configured in the Aspire. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/serversconnections

Pagination query string parameters

Common filter

Response

Sorting query string parameter

Section

Get all connections, filtered

Lists connections configured in the Aspire, filtered by a specified criteria. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

Code Block

language	js

{
    "servercount": [{
    {
      "idtotalItems": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
  2
    },
    "typeconnection": [
    "filesystem",    {
      
      "descriptionid": "Local Storagef0e88016-1a27-42b6-a5ae-31ab2226dbdc",
            "createdtype": 1596707252548"ldap",
	            "updateddescription": 1596707252548"LDAp-ik",
            "properties": {
 This is a dynamic JSON object}
    },
    {
      "iduseScript": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4false",
      "type": "smb",
          "descriptionuseSearchBase": "Remote Storagetrue",
          "created": 1596707252548,
	  "updated": 1596707252548,
	  "credentialserver": "cred_1ldap://localhost:20389",
      "properties":  { This is a dynamic JSON object}
   "authentication": "simple",
      }
  ],
  "from": 100,
  "size": 10,
  "sortByuser": "idcn=admin,dc=accenture,dc=com",
  "sortMode": "asc"
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response code Description

200 Success

Section

Get all servers, filtered

Lists servers configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/servers/getAll

Pagination query string parameters

Common filter

Response

Section

Get a single server

Get information about a single server configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/servers/:id

Path Parameters

Name Type Required Description

id string Required The id of the server to return

Code Block

language	js

{
  "server": {
              "password": "Adm1n!",
                "searchBase": "dc=accenture,dc=com",
                "userQuery": "(objectClass=person)",
                "groupQuery": "(objectClass=groupOfUniqueNames)",
                "userAttributes": "<users><attribute>uid</attribute><attribute>givenName</attribute></users>",
                "userKeyAttr": "dn",
                "iduserNameAttr": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4uid",
      "type          "groupKeyAttr": "smbdn",
       "description": "Remote Storage",
         "createdgroupNameAttr": 1596707252548"ou",
	  "updated": 1596707252548,
	              "credentialgroupMappingAttr": "cred_1uniqueMember",
       "properties         "groupsHoldMembers": { This is a dynamic JSON object}
"true",
              },
  "messageuserGUID": "optional response message"
}

Status

Response codeDescription200Success404The given server id was not found Section

Add servers

Add servers to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/servers

Body Parameters

NameTypeRequiredDescriptiontypestringRequired

The type of server to add

descriptionstringRequiredAn optional description of the servercredentialsstringOptionalCredentials can be specified for the serverpropertiesJSONRequiredDynamic JSON object with server properties (from dxf)

Example

Code Block

language	js

POST /aspire/_api/servers
[{
   "type": "filesystem",
   "description": "Local storage",
   "properties": { This will be a dynamic JSON object }
 },
 {
   "type": "filesystem",
   "description": "Remote Storage",
   "credential": "cred_1",
true",
                "userGUIDName": "objectGUID",
                "isBinaryGUID": "true",
                "lowerCase": "false"
            }
        },
        {
            "id": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
            "type": "filesystem",
            "description": "Fs-ik",
            "properties": { This will be a dynamic JSON object }
}]

Response

Code Block

language	js

{
  "server": [
                "multipleStartPoints": "false",
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "typeurl":   "filesystem"C:\\tmp\\ach1",
          
      "descriptionpartialScan": "Local Storagefalse",
      "created": 1596707252548,
	  "updated": 1596707252548,
      "propertiessubDirUrl": {null,
 This is a dynamic JSON object}
    },
    {
      "idindexContainers": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4false",
        "type": "smb",
        "descriptionscanRecursively": "Remote Storagetrue",
          "created": 1596707252548,
	  "updated": 1596707252548,
	  "credentialscanExcludedItems": "cred_1false",
      "properties": { This is a dynamic JSON object}
    }
  ]
}

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the input

"ignoreScanErrors": "false",
                "ignoreSymLinks": "false",
                "useACLs": "false",
                "acls": null,
                "includes": ".*test1.*",
                "excludes": null
            }
        }
    ]
}

Status: 200

Example

Section

Get a single connection

Get information about a single connection configured in Aspire. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the connection to return

Section

Update servers

Update servers in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/servers

Body Parameters

Name Type Required Description

id string Required The identifier of the server to update

type

string

Optional

The type of server to add

description string Optional An optional description of the server

credentials string Optional Credentials can be specified for the server

properties JSON Optional Dynamic JSON object with server properties (from dxf)

Code Block

language	js

PUT /aspire/_api/servers
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Local Storage",
    "type": "filesystem"
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "description": "Remote Storage",
    "credential": "cred_2"
  }
}

Response

Code Block

language	js
theme	RDark

{
  "serverconnection": [
    {
      "id": "AAABcID5GBc5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type":   "filesystemsmb",        
      "description": "LocalRemote Storage",
 	     "createdcredential": 1596707252548,
	  "updated": 1596707252548"cred_1",
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "  "AAABcIueWUc=",
      "type": "smb",
      "description": "Remote Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ]
}

Status

Response codeDescription201Created404Not found - a given server identifier was not found406Not acceptable - there was an issue validating the input Section

Delete multiple servers, filtered

Delete multiple servers from Aspire, filtered by a specified criteria

Status: 200, 404

Section

Add connection(s)

Add connections to Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections

Body Parameters

Name	Type	Required	Description
type	string	Required	The type of server to add
description	string	Required	An optional description of the server
credential	string	Optional	Credential id can be specified for the server
deleteIncrementalPolicy	string	Optional	Delete policy id
throttlePolicy	string	Optional	Throttle policy id
routingPolicies	string array	Optional	Routing policies ids
properties	JSON	Required	Dynamic JSON object with server properties

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/connections
[{
   "type": "filesystem",
   "description": "Local storage",
   "deleteIncrementalPolicy": "deletePolicyId",
   "throttlePolicy": "throttlePolicyId",
   "routingPolicies": ["routingPolicyId1", "routingPolicyId2"],
   "properties": { This will be a dynamic JSON object }
 },
 {
   "type": "filesystem",
   "description": "Remote Storage",
   "credential": "cred_1",
   "properties": { This will be a dynamic JSON object }
}]

Response

Code Block

language	js
theme	RDark

{
  "connection": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",        
      "description": "Local Storage",
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ]
}

See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors.

Status: 201, 406

Section

Update connection(s)

Update connections in Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connections/:id

PUT /aspire/_api/connections

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connection to update

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connection to update
(see add connection)		x

x - at least one field must be present

Example

Code Block

language	js
theme	RDark

PUT /aspire/_api/connections
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Local Storage",
    "properties": { This is a dynamic JSON object}
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "description": "Remote Storage",
    "credential": "cred_2"
  }
}

Response

Code Block

language	js
theme	RDark

{"server":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}

Status: 200, 404, 406

Section

Update connections, filtered

Update connections configured in the Aspire, filtered by a specified criteria. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connections/updateAll

Filters: The connection filter definition here

Update body parameter

Code Block

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION"
	"credential" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"properties" : {},
    "deleteIncrementalPolicy": "deletePolicyId",
	"routingPolicies" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.add" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.remove" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
  }
}

Response

Code Block

language	js
theme	RDark

{
  "message": "update result response message"
}

Status: 200, 406

Section

Delete connection(s)

Delete one or more connections from Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/connections/:id

DELETE /aspire/_api/connections

POST /aspire/_api/connections/delete

Path Parameters and Query parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the connection(s) to delete

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the connection(s) to delete

Examples

Code Block

language	js
theme	RDark

DELETE /aspire/_api/connections/AAABcID5GBc

DELETE /aspire/_api/connections?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/connections/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js
theme	RDark

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Section

Delete multiple connections, filtered

Delete multiple connections from Aspire, filtered by a specified criteria. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/deleteAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "message": "optional response message"
}

Status: 200

Section

Export connection(s)

Export one or more connections from Aspire. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections/export

GET /aspire/_api/connections/export/:id

POST /aspire/_api/connections/exportAll

Info

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Note
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Note
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

Path Parameters and Query parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the connection(s) to export

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the connection(s) to export

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/connections/export/AAABcID5GBc

DELETE /aspire/_api/connections/export?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/connections/export
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RESTConnection",
          "credential": "<credential_id>",
          "properties": {
            ...
          }
        },
		...
      ]
    },
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "RESTCredentials",
          "properties": {
            "type": "bearer",
            "query": {
              ...
            }
          }
        },
		...
      ]
    }
  }
}

Status: 200, 404, 406

Section

Export multiple connections, filtered

Export multiple connections from Aspire, filtered by a specified criteria. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RESTConnection",
          "credential": "<credential_id>",
          "properties": {
            ...
          }
        },
		...
      ]
    },
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "RESTCredentials",
          "properties": {
            "type": "bearer",
            "query": {
              ...
            }
          }
        },
		...
      ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Seed filter:

Code Block

language	js
theme	RDark

{ 
  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
    "deleteIncrementalPolicy": "deletePolicyId",
	"credentials" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"routingPolicies" : ["RP1", "RP2", "RP3", ...]
  }
}

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/servers/deleteAll

Body Parameters

NameTypeRequiredDescriptionfilterJSONRequiredFilters retrieved servers. Check the filter definition here

Response

Code Block

language	js

{
  "message": "optional response message"
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

Response codeDescription200Success404Not found - a given credential identifier was not found406Not acceptable - there was an issue validating the input Section

Delete single server

Delete a single server from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/servers/:id

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the server to delete

Example

Code Block

language	js

DELETE /aspire/_api/servers/AAABcID5GBc%3D

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given server identifier was not found406Not acceptable - there was an issue validating the input Section

Get server type dxf (TODO)

Returns the dxf for a specific server type

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/servers/type/:typeId/dxf

Path Parameters

NameTypeRequiredDescriptiontypeIdstringRequiredThe id of the type for which dxf is going to be retrieved

Response

Code Block

language	js

{
  "dxf": {...}
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given service identifier was not found

Page tree

Versions Compared

Old Version 12

New Version Current

Key

Get all

connections

Get all connections, filtered

Get all servers, filtered

Get a single server

Add servers

Get a single connection

Update servers

Delete multiple servers, filtered

Add connection(s)

Update connection(s)

Update connections, filtered

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Delete single server

Get server type dxf (TODO)

Page tree

Page History

Versions Compared

Old Version 12

New Version Current

Key

Get all

connections

Get all connections, filtered

Get all servers, filtered

Get a single server

Add servers

Get a single connection

Update servers

Delete multiple servers, filtered

Add connection(s)

Update connection(s)

Update connections, filtered

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Delete single server

Get server type dxf (TODO)

Filters
Anchor
FiltersAnchor
FiltersAnchor