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/servers

Query String Parameters

Name Type Required Description

xx string Optional

connections

Pagination query string parameters

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

xx

Response

Code Block

language	js
theme	RDark

{
    "server"count": {
        "totalItems": 2
    },
    "connection": [
        {
            "id": "191283d9f0e88016-1a27-183e42b6-4820-8932-32b1fa07d2d5",
      .....
    },
    {
a5ae-31ab2226dbdc",
            "type": "ldap",
            "description": "LDAp-ik",
            "properties": {
                "useScript": "false",
                "useSearchBase": "true",
                "server": "ldap://localhost:20389",
                "authentication": "simple",
                "user": "cn=admin,dc=accenture,dc=com",
                "password": "Adm1n!",
                "searchBase": "dc=accenture,dc=com",
                "userQuery": "(objectClass=person)",
                "groupQuery": "(objectClass=groupOfUniqueNames)",
                "userAttributes": "<users><attribute>uid</attribute><attribute>givenName</attribute></users>",
                "userKeyAttr": "dn",
                "userNameAttr": "uid",
                "groupKeyAttr": "dn",
                "groupNameAttr": "ou",
                "groupMappingAttr": "uniqueMember",
                "groupsHoldMembers": "true",
                "userGUID": "true",
                "userGUIDName": "objectGUID",
                "isBinaryGUID": "true",
                "lowerCase": "false"
            }
        },
        {
            "id": "5d0b35d598960f72-aab0-c9464ba1-44e7-9be5-97c9ad9036a3",
a90e-b29d4e3c2c92",
            "type": "filesystem",
            "description": "Fs-ik",
            "properties": {
                "multipleStartPoints": "false",
                "url": "C:\\tmp\\ach1",
                "partialScan": "false",
                "subDirUrl": null,
                "indexContainers": "false",
                "scanRecursively": "true",
                "scanExcludedItems": "false",
                "ignoreScanErrors": "false",
                "ignoreSymLinks": "false",
                "useACLs": "false",
                "acls": null,
                "includes": ".....
*test1.*",
                "excludes": null
            }
        }
    ]
}

Status

Response codeDescription

: 200

Success

: 200, 404

Section

Get a single

server

connection

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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/serversconnections/:id

Path Parameters

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

Response

Code Block

language	js
theme	RDark

{
  "serverconnection": {
      "id": "191283d95d0b35d5-183ec946-482044e7-89329be5-32b1fa07d2d597c9ad9036a4",
      "type": "smb",
      }"description": "Remote Storage",
	  "messagecredential": "optional response message""cred_1",
      "properties": { This is a dynamic JSON object}
    }
}

Status

Response code Description

200 Success

404 The given server id was not found

Section

Add

servers

connection(s)

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/serversconnections

Request Body Parameters

Name	Type	Required	Description
xxtype	string	Required	The type of server to add
description	xx	xx	string	OptionalRequired	An optional xx of the server

Examples

Add a single server

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/serversconnections
[{
   "servertype": "c:\\testdata\\2500filesystem",
   "typedescription": "filesystemLocal storage"
}

Add multiple servers

Code Block

language	js

POST /aspire/_api/servers
[{
,
   "serverdeleteIncrementalPolicy": "c:\\testdata\\2500deletePolicyId",
   "typethrottlePolicy": "filesystemthrottlePolicyId"
},
{
   "serverroutingPolicies": ["routingPolicyId1", "c:\\testdata\\250000"routingPolicyId2"],
   "connectorproperties": "connector_1",
 { This will be a dynamic JSON object }
 },
 {
   "descriptiontype": "250,000 filesfilesystem",
   "credentialdescription": "cred_1Remote Storage",
   "policycredential": "policycred_1",
   "workflowproperties": ["workflow_1","workflow_99"]{ This will be a dynamic JSON object }
}]

Response

Code Block

language	js
theme	RDark

{
  "serverconnection": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",        
      "description": "Local Storage",
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",

  }]
}

Status

Response code Description

201 Created

406 Not acceptable - there was an issue validating the input

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.

Section

Update servers

Update one or more servers in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/serversconnections/:id

PUT /aspire/_api/serversconnections

Request Body Path Parameters

string

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

Body Parameters

xx

Name	Type	Required	Description
xxid	string	Optional	An optional xx of the server

Examples

Required	The identifier of the connection to update
(see add connection)		x

x - at least one field must be present

ExampleUpdate a single server

Code Block

language	js
theme	RDark

PUT /aspire/_api/servers/AAABcID5GBc%3Dconnections
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "serverdescription": "c:\\testdata\\2500Local Storage",
    "typeproperties": "filesystem"
}

Update multiple servers

Code Block

language	js

PUT /aspire/_api/servers
{ { This is a dynamic JSON object}
  },
  "AAABcID5GBcAAABcIueWUc=": {
    "id": "AAABcID5GBcAAABcIueWUc=",
    "serverdescription": "c:\\testdata\\2500Remote Storage",
    "typecredential": "filesystemcred_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

{
  "

AAABcIueWUc=

update" : {
    "

id

description" : "

AAABcIueWUc=

DESCRIPTION"

,


	"credential" : "credentialId",
	"throttlePolicy" : "

server": "c:\\testdata\\250000"

throttlePolicyId",
	"properties" : {},
    "

connector

deleteIncrementalPolicy": "

connector_1

deletePolicyId",
	"routingPolicies" :

"description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"

["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

{
  "

server

message":

[{ "id": "AAABcID5GBc=", }, { "id": "AAABcIueWUc=", }] }

Status

Response code Description

201 Created

404 Not found - a given server identifier was not found

406 Not acceptable - there was an issue validating the input

Section

 "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.

Delete servers

Delete one or more servers from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections/export

GET DELETE /aspire/_api/connections/serversexport/:idDELETE

POST /aspire/_api/serversconnections/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 parametersPath and Query String 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 server(s) to deleteexport

Examples

Delete a single server

Code Block

language	js
theme	RDark

DELETEGET /aspire/_api/connections/servers/AAABcID5GBc%3D

Delete multiple servers

Code Block

language	js

export/AAABcID5GBc

DELETE /aspire/_api/connections/serversexport?id=AAABcID5GBc%3DAAABcID5GBc&id=AAABcIueWUc%3DAAABcID5GBd

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": {
  "message": "optional response message"
}

Status

    "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

Not acceptable - there was an issue validating the input

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", ...]
  }
}

Response code

Description

200

Success

404

Not found - a given server identifier was not found

406

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Get all

connections

Get all connections, filtered

Get a single

connection

Add

connection(s)

Update connection(s)

Update servers

Update connections, filtered

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Delete servers

Export multiple connections, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

Get all

connections

Get all connections, filtered

Get a single

connection

Add

connection(s)

Update connection(s)

Update servers

Update connections, filtered

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Delete servers

Export multiple connections, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor