Swagger Aplications and Services to Aplications and Services Interoperability API Reference

Admin API Methods about AS2AS

API Endpoint

http://localhost:1880/

Terms of Service: http://swagger.io/terms/

Schemes: http

Version: 1.0.0

Authentication

petstore_auth

type

oauth2

authorizationUrl

http://petstore.swagger.io/oauth/dialog

flow

implicit

scopes

write:pets

modify pets in your account

read:pets

read your pets

api_key

type

apiKey

name

api_key

header

auth

Authentication and Credentials

auth

Get the active authentication scheme

GET /auth/login

200 OK

Credentials

successful operation

type

Credentials

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "string",
    "type": "string",
    "label": "string"
  }
]

auth

Exchange credentials for access token

POST /auth/token

Client

Flow entry description

Authorization: string

in header

token

Request Content-Types: application/json

Request Example

{
  "client_id": "string",
  "grant_type": "string",
  "scope": "array",
  "username": "string",
  "password": "string"
}

200 OK

Token

successful operation

type

Token

405 Method Not Allowed

Not authorized

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "access_token": "string",
    "expires_in": "integer (int64)",
    "token_type": "string"
  }
]

auth

Revoke an access token

POST /auth/revoke

Authorization: string

in header

token

Token: string

in header

The token to revoke

200 OK

Token

successful operation

type

Token

405 Method Not Allowed

Not authorized

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "access_token": "string",
    "expires_in": "integer (int64)",
    "token_type": "string"
  }
]

settings

Runtime Settings

settings

Get the runtime settings

GET /settings

Authorization: string

in header

token

Content-type: string

in header

The token to revoke

200 OK

successful operation

type

object

401 Unauthorized

Not authorized

Response Example (200 OK)

{
  "httpNodeRoot": "string",
  "version": "string",
  "user": "object"
}

flows

Active Flow Configuration

flows

Get the active flow configuration.

GET /flows

Authorization: string

in header

token

Node-RED-API-Version: string

in header

The api version being used. Defaults to v1 if not set.

200 OK

V2flowresp

v1 An array of node objects v2. A flow response object that includes the current revision identifier of the flows

type

V2flowresp

400 Bad Request

An Error response

401 Unauthorized

Not authorized

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "rev": "string",
    "flows": {
      "type": "string",
      "id": "string",
      "label": "string"
    }
  }
]

flows

Set the active flow configuration

POST /flows

V2flowresp

Flow response object

Authorization: string

in header

token

Node-RED-API-Version: string

in header

The api version being used. Defaults to v1 if not set.

Node-RED-Deployment-Type: string

in header

full, nodes, flows or reload

Request Content-Types: application/json

Request Example

{
  "rev": "string",
  "flows": {
    "type": "string",
    "id": "string",
    "label": "string"
  }
}

200 OK

successful operation

type

object

204 No Content

Success

400 Bad Request

Invalid API version

401 Unauthorized

Not authorized

409 Conflict

Version mismatch

Response Content-Types: application/json

Response Example (200 OK)

{
  "rev": "string"
}

Schema Definitions

Credentials: object

id: string
type: string
label: string

Example

{
  "id": "string",
  "type": "string",
  "label": "string"
}

Token: object

access_token: string
expires_in: integer (int64)
token_type: string

Example

{
  "access_token": "string",
  "expires_in": "integer (int64)",
  "token_type": "string"
}

Node: object

id: integer (int64)
type: string
x: string
y: string
z: string
wires: string

Example

{
  "id": "integer (int64)",
  "type": "string",
  "x": "string",
  "y": "string",
  "z": "string",
  "wires": "string"
}

Subflow: object

id: string
type: string
name: string
info: object

Example

{
  "id": "string",
  "type": "string",
  "name": "string",
  "info": "object"
}

Flows: object

id: string
type: string

Example

{
  "id": "string",
  "type": "string"
}

Flow: object

id: string
label: string
nodes: string
configs: string
subflows: string

Example

{
  "id": "string",
  "label": "string",
  "nodes": "string",
  "configs": "string",
  "subflows": "string"
}

Module: object

name: string
version: string
nodes: array

Example

{
  "name": "string",
  "version": "string",
  "nodes": "array"
}

Set: object

id: string
name: string
types: array
enabled: string
module: string
version: string

Example

{
  "id": "string",
  "name": "string",
  "types": "array",
  "enabled": "string",
  "module": "string",
  "version": "string"
}

Client: object

client_id: string
grant_type: string
scope: array
username: string
password: string

Example

{
  "client_id": "string",
  "grant_type": "string",
  "scope": "array",
  "username": "string",
  "password": "string"
}

V1flowresp: object

type: string
id: string
label: string

Example

{
  "type": "string",
  "id": "string",
  "label": "string"
}

V2flowresp: object

rev: string
flows: object
type: string id: string label: string

Example

{
  "rev": "string",
  "flows": {
    "type": "string",
    "id": "string",
    "label": "string"
  }
}

Error: object

code: string
message: string

Example

{
  "code": "string",
  "message": "string"
}

Documentation by Spectacle