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

from integer Optional Indicates the initial page to be retrieved

size integer Optional Specifies the size of results page

sortBy string Optional Field by which results are sorted

sortMode

string

Optional

Sort mode

"asc" for ascending sort,
"desc" for descending sort

expand 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

List of fields to expand, * will expand everything

Response

Code Block

language	js
theme	RDark

{
    "servercount": [{
    {
      "idtotalItems": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
  2
    },
    "typeconnection": [
  "filesystem",      {
    
        "descriptionid": "Local Storagef0e88016-1a27-42b6-a5ae-31ab2226dbdc",
         "created": 1596707252548,
	  "updatedtype": 1596707252548"ldap",
      "properties": { This is a dynamic JSON object}
 "description": "LDAp-ik",
   },
    {
      "idproperties": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
{
         "type": "smb",
      "descriptionuseScript": "Remote Storagefalse",
      "created": 1596707252548,
	  "updated": 1596707252548,
	          "credentialuseSearchBase": "cred_1true",
      "properties": { This is a dynamic JSON object}
    }
  ],
  "from": 100,
  "size": 10,
  "sortBy"server": "ldap://localhost:20389",
                "authentication": "idsimple",
  "sortMode              "user": "asc"cn=admin,dc=accenture,dc=com",
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response codeDescription200Success 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

Query String Parameters

NameTypeRequiredDescriptionfromintegerOptionalIndicates the initial page to be retrievedsizeintegerOptionalSpecifies the size of results pagesortBystringOptionalField by which results are sortedsortModestringOptional

Sort mode

"asc" for ascending sort,
"desc" for descending sort

expandstringOptionalList of fields to expand, * will expand everything

Body Parameters

NameTypeRequiredDescriptionfilterJSONRequiredFilters retrieved servers. Check the filter definition here

Response

Code Block

language	js

{
  "server": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",        "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",
          
      "descriptiongroupKeyAttr": "Local Storagedn",
      "created": 1596707252548,
	  "updated": 1596707252548,
      "propertiesgroupNameAttr": {"ou",
 This is a dynamic JSON object}
    },
    {
      "idgroupMappingAttr": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4uniqueMember",
                "typegroupsHoldMembers": "smbtrue",
      "description": "Remote Storage",
          "createduserGUID": 1596707252548"true",
	      "updated": 1596707252548,
	  "credential": "cred_1",
      "propertiesuserGUIDName": "objectGUID",
  { This is a dynamic JSON object}
    }
  ],
  "fromisBinaryGUID": 100,
  "sizetrue": 10,
  "sortBy              "lowerCase": "idfalse",
      "sortMode": "asc"
  "totalItems": 10000      }
        },
  "message": "optional response message"
}

Status

Response codeDescription200Success 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

NameTypeRequiredDescriptionidstringRequiredThe id of the server to return

Query String Parameters

NameTypeRequiredDescriptionexpandstringOptionalList of fields to expand, * will expand everything

Response

Code Block

language	js

{
  "server": {
      {
            "id": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
            "idtype": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4filesystem",
      "type": "smb",
      "description": "Remote StorageFs-ik",
            "createdproperties": 1596707252548,
	  "updated": 1596707252548,
	{
                "credentialmultipleStartPoints": "cred_1false",
      "properties": { This is a dynamic JSON object}
    }"url": "C:\\tmp\\ach1",
  "message": "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",
   "properties": { This will be a dynamic JSON object }
}]

Response

Code Block

language	js

{
  "server": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",            "partialScan": "false",
                "subDirUrl": null,
                "indexContainers": "false",
                "scanRecursively": "true",
                "scanExcludedItems": "false",
                "ignoreScanErrors": "false",
                "ignoreSymLinks": "false",
                "useACLs": "false",
                "acls": null,
          
      "descriptionincludes": "Local Storage.*test1.*",
      "created": 1596707252548,
	  "updated": 1596707252548,
      "propertiesexcludes": null
  { This is a dynamic JSON object}
    },
     {
   }
   "id":  ]
}

Status: 200

: 200, 404

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

Response

Code Block

language	js
theme	RDark

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

Status

Response code Description

201 Created

406 Not acceptable - there was an issue validating the input

Section

Add connection(s)

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

Section

Update servers

Update servers in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT POST /aspire/_api/serversconnections

Body Parameters

credentialsCredentials Optional (from dxf)

Name	Type	Required	Description
idtype	string	Required	The identifier type of the server to update add type
description	string	Optional	The type of server to add	Required	description	string	Optional	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

POSTPUT /aspire/_api/servers
{
  "AAABcID5GBc=": connections
[{
    "idtype": "AAABcID5GBc=filesystem",
    "description": "Local Storagestorage",
    "typedeleteIncrementalPolicy": "filesystemdeletePolicyId"
  },
  "AAABcIueWUc=": {
    "idthrottlePolicy": "AAABcIueWUc=throttlePolicyId",
    "descriptionroutingPolicies": ["routingPolicyId1"Remote, Storage"routingPolicyId2"],
    "credentialproperties": "cred_2"
  }
}

Response

Code Block

language	js

{
  "server": [
    {
   { This will be a dynamic JSON object }
 },
 {
   "idtype": "AAABcID5GBcfilesystem",
      "typedescription": "Remote  Storage"filesystem",
        
   "credential": "cred_1",
   "descriptionproperties": { This will be a dynamic JSON object }
}]

Response

Code Block

language	js
theme	RDark

{
  "connection": ["Local Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
    {
      "propertiesid": { This is a dynamic JSON object}
    },
    {"5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "idtype": "  "AAABcIueWUc=filesystem",
       "type": "smb",
      "description": "RemoteLocal Storage",
      "createdproperties": 1596707252548{ This is a dynamic JSON object}
    },
	   "updated": 1596707252548,
	 {
      "credentialid": "cred_15d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "propertiestype": {"smb",
 This is a dynamic JSON  "description": "Remote Storage",
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ]
}

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

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

Status: 201, 406

Example

Section

Update connection(s)

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

Delete multiple servers, filtered

Delete multiple servers from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST PUT /aspire/_api/servers/deleteAll/connections/:id

PUT /aspire/_api/connections

Path Body Parameters

Name	Type	Required	Description
filterid	JSONstring	Required	Filters retrieved servers. Check the filter definition here	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

ExampleResponse

Code Block

language	js
theme	RDark

PUT /aspire/_api/connections
{
  "messageAAABcID5GBc=": "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 code Description

200 Success

404 Not found - a given credential identifier was not found

406 Not acceptable - there was an issue validating the input

Section

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

Delete single server

Delete a single server from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE

/aspire/_api/

servers

connections/

:id

Path Parameters

Name Type Required Description

id string Required The identifier of the server to delete

Code Block

language	js

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

Response

js

updateAll

Filters: The connection filter definition here

Update body parameter

Code Block

theme	RDark

Code Block

language

{
  "

message

update" : {
    "

optional

description"

response

message" }

Status

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

"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

Response

Section

Import

The import usage can be found here

Section

Get server type dxf

Returns the dxf for a specific server type

Panel

borderColor	black
bgColor	#fafafb

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

Path Parameters

Name Type Required Description

typeId string Required The id of the type for which dxf is going to be retrieved

Code Block

language	js

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

Status

Response codeDescription200Success404Not found - a given service identifier was not found

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Credentials Seed filter:

Code Block

languagelanguage	js
theme	jsRDark

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

Note

When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.

Page tree

Versions Compared

Old Version 11

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

Add connection(s)

Update servers

Update connection(s)

Delete multiple servers, filtered

Update connections, filtered

Delete single server

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Import

Get server type dxf

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 11

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

Add connection(s)

Update servers

Update connection(s)

Delete multiple servers, filtered

Update connections, filtered

Delete single server

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Import

Get server type dxf

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor