Versions Compared

Old Version 4

changes.mady.by.user Freddy Morera

Saved on

compared with

New Version 5

changes.mady.by.user Freddy Morera

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titlePage in development

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

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

Table of Contents

Section

Get all servers

Lists all the servers configured in the Aspire

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

Query String Parameters

NameTypeRequiredDescription
xxstringOptionalxx

Response

Code Block
languagejs
{
  "server": [
    {
       "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
       "type": {
          "id": "ldap-cachefilesystem",
          "name": "LDAPFile cacheSystem"
        },
        "description": "AmericaLocal LDAPStorage",
        "created": 1596707252548,
        "properties": { This is a dynamic JSON object }
     },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type": {
        "id": "group-expansionsmb",
        "name": "Group expansion serviceSMB"
      },
      "description": "GroupRemote ExpansionStorage",
      "created": 1596707252548,
      "properties": { This is a dynamic JSON object }
    }
  ],
  "from": 100,
  "size": 10,
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response codeDescription
200Success



Section

Get a single server

Get information about a single server configured in Aspire

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/servers/:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the server to return

Response

Code Block
languagejs
{
  "server": {
    "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
    "type": {
       "id": "ldap-cachesmb",
       "name": "LDAP cacheSMB"
     },
     "description": "AmericaSMB Net LDAPApp",
     "created": 1596707252548,
     "properties": { This is a dynamic JSON object }
  },
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404The given server id was not found



Section

Add servers

Add one or more servers to Aspire

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

Request Body Parameters

NameTypeRequiredDescription
xxstringRequiredxx
xxstringOptionalAn optional xx of the server

Examples

Add a single server

Code Block
languagejs
POST /aspire/_api/servers
{
  "server": "c:\\testdata\\2500",
  "type": "filesystem"
}

Add multiple servers

Code Block
languagejs
POST /aspire/_api/servers
[{
  "server": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "server": "c:\\testdata\\250000",
  "connector": "connector_1",
  "description": "250,000 files",
  "credential": "cred_1",
  "policy": "policy_1",
  "workflow": ["workflow_1","workflow_99"]
}]

Response

Code Block
languagejs
{
  "server": [{
    "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",

  },
  {
    "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",

  }]
}

Status

Response codeDescription
201Created
406Not acceptable - there was an issue validating the input



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
borderColorblack
bgColor#fafafb

PUT /aspire/_api/servers/:id

PUT /aspire/_api/servers

Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the server to update
xxstringRequiredxx
xxstringOptionalAn optional xx of the server

Examples

Update a single server

Code Block
languagejs
PUT /aspire/_api/servers/AAABcID5GBc%3D
{
  "id": "AAABcID5GBc=",
  "server": "c:\\testdata\\2500",
  "type": "filesystem"
}

Update multiple servers

Code Block
languagejs
PUT /aspire/_api/servers
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "server": "c:\\testdata\\2500",
    "type": "filesystem"
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "server": "c:\\testdata\\250000",
    "connector": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
  }
}

Response

Code Block
languagejs
{
  "server": [{
    "id": "AAABcID5GBc=",

   },
   {
    "id": "AAABcIueWUc=",

  }]
}

Status

Response codeDescription
201Created
404Not found - a given server identifier was not found
406Not acceptable - there was an issue validating the input



Section

Delete servers

Delete one or more servers from Aspire.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/servers/:id

DELETE /aspire/_api/servers

Path and Query String Parameters

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

Examples

Delete a single server

Code Block
languagejs
DELETE /aspire/_api/servers/AAABcID5GBc%3D

Delete multiple servers

Code Block
languagejs
DELETE /aspire/_api/servers
{
  "id": [ "AAABcID5GBc=", "AAABcIueWUc=" ]
}

Response

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

Status

Response codeDescription
200Success
404Not found - a given server identifier was not found
406Not acceptable - there was an issue validating the input