Key

get

Responses

200

OK

*/*

totalPagesinteger · int32Optional

totalElementsinteger · int64Optional

sizeinteger · int32Optional

numberinteger · int32Optional

numberOfElementsinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

emptybooleanOptional

404

Not Found

*/*

get

/api/v1/key

HTTPcURLJavaScriptPython

GET /api/v1/key HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "size": 1,
  "content": [
    {
      "description": "text",
      "ptsp": "text",
      "ptspCode": "text",
      "host": "text",
      "port": 1,
      "type": "COMPONENT",
      "active": true,
      "dateCreated": "text",
      "dateModified": "text",
      "lastActiveDate": "text"
    }
  ],
  "number": 1,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true
  },
  "first": true,
  "last": true,
  "empty": true
}

post

Body

application/json

component1stringRequired

component2stringRequired

descriptionstringRequired

ptspstringRequired

ptspCodestringRequired

hoststringRequired

portinteger · int32Required

typestring · enumRequiredPossible values:

activebooleanRequired

Responses

200

OK

*/*

statusstring · enumRequiredPossible values:

messagestringRequired

404

Not Found

*/*

post

/api/v1/key

HTTPcURLJavaScriptPython

POST /api/v1/key HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "component1": "text",
  "component2": "text",
  "description": "text",
  "ptsp": "text",
  "ptspCode": "text",
  "host": "text",
  "port": 1,
  "type": "COMPONENT",
  "active": true
}

{
  "status": "FAIL",
  "message": "text"
}

put

Body

application/json

component1stringRequired

component2stringRequired

descriptionstringRequired

ptspstringRequired

ptspCodestringRequired

hoststringRequired

portinteger · int32Required

typestring · enumRequiredPossible values:

activebooleanRequired

Responses

200

OK

*/*

statusstring · enumRequiredPossible values:

messagestringRequired

404

Not Found

*/*

put

/api/v1/key

HTTPcURLJavaScriptPython

PUT /api/v1/key HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "component1": "text",
  "component2": "text",
  "description": "text",
  "ptsp": "text",
  "ptspCode": "text",
  "host": "text",
  "port": 1,
  "type": "COMPONENT",
  "active": true
}

{
  "status": "FAIL",
  "message": "text"
}