Versions Compared

Old Version 29

changes.mady.by.user Petr Podsednik

Saved on

compared with

New Version Current

changes.mady.by.user Helmuth Rowe Hilton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The servers 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
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Section

Get all

servers

connections

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

Panel
borderColorblack
bgColor#fafafb
GET /aspire/_api/serversconnections

Pagination query string parameters

Sorting query string parameter

Section

Get all

servers

connections, filtered

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

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/serversconnections/getAll

Pagination query string parameters

Sorting query string parameters

FiltersFilters: The server connection filter definition here

Response

Code Block
languagejs
themeRDark
{
    "count": {
        "totalItems": 2
    },
    "serverconnection": [
        {
            "id": "f0e88016-1a27-42b6-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": "98960f72-aab0-4ba1-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: 200



Section

Get a single

server

connection

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

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/serversconnections/:id


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the server connection to return


Response

Code Block
languagejs
themeRDark
{
  "serverconnection": {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
}

Status: 200, 404



Section

Add

server

connection(s)

Add servers connections to Aspire, this endpoint need the . This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb
POST /aspire/_api/serversconnections


Body Parameters

NameTypeRequiredDescription
typestringRequired

The type of server to add

descriptionstringRequiredAn optional description of the server
credentialstringOptionalCredential id can be specified for the server
deleteIncrementalPolicystringOptionalDelete policy id
throttlePolicystringOptionalThrottle policy id
routingPoliciesstring arrayOptionalRouting policies ids
propertiesJSONRequiredDynamic JSON object with server properties


Example

Code Block
languagejs
themeRDark
POST /aspire/_api/serversconnections
[{
   "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
languagejs
themeRDark
{
  "serverconnection": [
    {
      "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 for details regarding the response body returned where multiple items are affected with some (or all) returning errors.

Status: 201, 406



Section

Update

server

connection(s)

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

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/serversconnections/:id

PUT /aspire/_api/serversconnections


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector connection to update


Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the server connection to update
descriptionstringxA description
credentialstringxCredential id can be specified for the server
throttlePolicystringxThrottle policy id
routingPoliciesstring arrayxRouting policies ids
propertiesJSONxDynamic JSON object with server properties

x - at least one field must be present

Example

(see add connection)
x

x - at least one field must be present


Example

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

Response

Code Block
languagejs
themeRDark
{"server":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}


Status: 200, 404, 406


Section

Update

servers

connections, filtered

Update

servers

connections configured in the Aspire, filtered by a specified criteria

, this endpoint need the

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

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/

servers

connections/updateAll

Filters: The

server

connection filter definition here

Update body parameter

Code Block
themeRDark
{
  "update" : {
    "description" : "DESCRIPTION"
	"credential" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"properties" : {},
"routingPolicies" 
    "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
languagejs
themeRDark
{
  "message": "update result response message"
}

Status: 200, 406



Examples

Section

Delete

multiple servers, filtered

connection(s)

Delete one or more connections from Aspire. This endpoint needs Delete multiple servers from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

POST DELETE /aspire/_api/serversconnections/deleteAll

Filters: The server filter definition here

Response

Code Block
languagejs
{
  "message": "optional response message"
}

Status: 200

Section

:id

DELETE /aspire/_api/connections

POST /aspire/_api/connections/delete


Path Parameters and Query parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the connection(s) to delete


Body Parameter

NameTypeRequiredDescription
idsstringRequiredThe

Delete servers(s)

Delete one or more servers from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/servers/:id

DELETE /aspire/_api/servers

POST /aspire/_api/servers/delete

Path Parameters and Query parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the serverconnection(s) to delete

Body Parameter


NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the server(s) to delete
Code Block
languagejs
themeRDark
DELETE /aspire/_api/serversconnections/AAABcID5GBc

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

POST /aspire/_api/servers/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}
connections?id=AAABcID5GBc&id=AAABcID5GBd

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


Response

Code Block
languagejs
themeRDark
{
  "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
borderColorblack
bgColor#fafafb

POST /aspire/_api/connections/deleteAll

Filters: The connection filter definition here

Response

Code Block
languagejs
themeRDark
{
  "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
borderColorblack
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

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the connection(s) to export


Body Parameter

NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the connection(s) to export


Examples

Code Block
languagejs
themeRDark
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
languagejs
themeRDark
{
  "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
borderColorblack
bgColor#fafafb

POST /aspire/_api/connections/exportAll

Filters: The connection filter definition here

Response

Code Block
languagejs
themeRDark
{
  "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

Response

Code Block
languagejs
{
  "message": "delete result response message"
}

Status: 200, 404, 406




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
languagejs
themeRDark
{ 
  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
    "deleteIncrementalPolicy": "deletePolicyId",
	"credentials" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"routingPolicies" : ["RP1", "RP2", "RP3", ...]
  }
}