Theme

LSP Services ​

API endpoints for LSP Services management in WORKSPACE.

Setup a LSP ​

http
POST /v1/:wid/lsp/setup

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Setup a LSPRequest {
  type: string;
  name: string;
  description: string;
  logo: string;
  contacts: {
    emails: string[];
    phones: string[]
  };
  address: {
    name: string;
    street1: string;
    city: string;
    state: string;
    country: string;
    coordinates: number[]
  };
}

Example:

json
{
  "type": "CARRIER",
  "name": "Mijo",
  "description": "Bus mobility transport service",
  "logo": "https://github.com/organizations/atlooh/settings/profile",
  "contacts": {
    "emails": [
      "[email protected]"
    ],
    "phones": [
      "+1 898 938 382 422",
      "+233 204 55323"
    ]
  },
  "address": {
    "name": "Bluesky Complex",
    "street1": "Spintex Road, Sakumono",
    "city": "Accra",
    "state": "Greater Accra",
    "country": "Ghana",
    "coordinates": [
      -0.1387423,
      5.1284859
    ]
  }
}

Get a LSP ​

http
GET /v1/:wid/lsp/:xcode

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Get All LSPs ​

http
GET /v1/:wid/lsps

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request LSP Context ​

http
GET /v1/:wid/lsp/:xcode/context

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Update a LSP ​

http
PATCH /v1/:wid/lsp/:xcode

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Delete a LSP ​

http
DELETE /v1/:wid/lsp/:xcode

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)