NextJtag API documentation version v1

http://localhost:19080/api/v1

This is the API interface served up by nextjtag_server. Some parts are still a work in progress, and methods marked EXPERIMENTAL are highly likely to change in the future.

Getting Started

To get the latest copy of nextjtag_server, check out the github page for nextjtag. Next, launch the server from a machine that has supported FPGAs connected via USB. Note that for full functionality, a license is required for each FPGA, and the server must be configured to use them.

Bitstreams

Bitstreams are files that contain the programming formation for a FPGA. Since they tend to be large, they must be uploaded to the server before they can be programmed into an FPGA.

Indexing

Bitstreams are indexed using their SHA256 hash, and this key is used when programming a bitstream. It can also be used to check if the server already has a cached copy of a bitstream. It is highly recommended that clients verify their bitstreams do not exist on the server before uploading a bitstream.

get post

get

Query list of bitstreams

post

Upload bitstream

Upload bitstream

Body

Media type: application/json

Type: object

Properties
  • description: (string)

    Customizable bittstream description (usually filename)

  • format: required(one of BIT, BIN)

    Bitstream file format (filename extension)

  • value: required(string)

    Base64 string of raw bitstream file

HTTP status code 200

Bitstream was successfully transfered, check error property to determine if it was successfully parsed.

Body

Media type: application/json

Type: object

Properties
  • bitstream: (object)

    Uploaded bitstream information

    • key: required(string)

      Bitstream key for API use

    • sha256: required(string)

      SHA256 hash of bitstream data

    • description: required(string)

      User provided description of bitstream (usually filename)

    • format: required(one of BIT, BIN)

      Bitstream file format

  • error: (object)

    Set if there was a bitstream parsing error

    • msg: required(string)
    • code: required(integer)

HTTP status code 400

Invalid request body

get delete

get

Query specific bitstream

delete

Delete bitstream from cache

Query specific bitstream

URI Parameters

  • id: required(string)

    Bitstream SHA256 hash string

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • bitstream: required(object)
    • key: required(string)

      Bitstream key for API use

    • sha256: required(string)

      SHA256 hash of bitstream data

    • description: required(string)

      User provided description of bitstream (usually filename)

    • format: required(one of BIT, BIN)

      Bitstream file format

Delete bitstream from cache

URI Parameters

  • id: required(string)

    Bitstream SHA256 hash string

HTTP status code 204

Operation successful

Boards

Boards are the basic abstraction for every device that nextjtag communicates with. Each board provides access to the one or more FPGAs on it, and to BMC if it is supported. To detect new boards and auto remove disconnected boards, a POST should be made to the root /boards resource.

Initialization

Before a board FPGA can be used, the board must be initialized first by POSTing to the board’s init resource. Initializing will open the board (if not already open), and will read information about the FPGAs (such FPGA type and DNA). A board can be initialized multiple times.

Board Management Controller (BMC)

To access the board’s BMC, it must be first setup by POSTing to the board’s bmc resource. Some BMCs can only be accessed through the FPGA, and require a bitstream loaded with special blocks. For these cases, nextjtag will prevent a new bitstream from being loaded while the BMC is using the FPGA. The BMC must disconnected by DELETing the board's bmc resource.

Concurrent Access

It is not possible perform more than one board action a the same time, due to limitations of the underlying hardware. For example, if two clients try to program a bitstream on the same board at the same time, one of them will succeed and the other will fail immediately with a 408 error. However, not all resources perform a board action, and some only returned cached information (such as the root board resource). These non-action resources can be accessed concurrently at any time.

get post

get

Query list of boards

post

Trigger a rescan to search for new boards and remove disconnected boards

Trigger a rescan to search for new boards and remove disconnected boards

Body

Media type: application/json

Type: object

Properties
  • init_new_boards: (boolean)

    Attempt to initializse new boards found during rescan; this option is ignored if auto-initialization is enabled

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • boards: required(array of object)

    List of new boards found during rescan

    Items: Board

    • key: required(string)

      Board key for API use

    • is_open: required(boolean)

      True if the board is opened by the OS

    • open_error: (object)

      Set if the last open call on this board resulted in an error

      • msg: required(string)
      • code: required(integer)
    • is_init: required(boolean)

      True if the board has been initialized

    • init_error: (object)

      Set if the last init call on this board resulted in an error

      • msg: required(string)
      • code: required(integer)
    • serial: required(string)

      Board serial string

    • description: required(string)

      Board description string

    • vendor: required(string)

      Board vendor string

    • bmc: required(object)

      BMC status and capabilities

      • is_setup: required(boolean)

        True the BMC is setup and ready to use

      • setup_error: (object)

        Set if the last BMC setup attempt resulted in an error

        • msg: required(string)
        • code: required(integer)
      • close_error: (object)

        Set if the last BMC close attempt resulted in an error

        • msg: required(string)
        • code: required(integer)
      • access_type: (one of DIRECT, FPGA)

        Method of BMC access, only populated if BMC is setup

      • sensor_list: (array of string)

        Supported sensors BMC can read, only populated if BMC is setup

    • fpgas: (array of Fpga)

      Fpgas on this board, only populated after initilization

      Items: Fpga

      • name: required(string)

        FPGA model name

      • dna: required(string)

        FPGA serial number

HTTP status code 400

Invalid request body

get delete

get

Query specific board

delete

Close and remove board

Query specific board

URI Parameters

  • board: required(string)

    Board Key

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • key: required(string)

    Board key for API use

  • is_open: required(boolean)

    True if the board is opened by the OS

  • open_error: (object)

    Set if the last open call on this board resulted in an error

    • msg: required(string)
    • code: required(integer)
  • is_init: required(boolean)

    True if the board has been initialized

  • init_error: (object)

    Set if the last init call on this board resulted in an error

    • msg: required(string)
    • code: required(integer)
  • serial: required(string)

    Board serial string

  • description: required(string)

    Board description string

  • vendor: required(string)

    Board vendor string

  • bmc: required(object)

    BMC status and capabilities

    • is_setup: required(boolean)

      True the BMC is setup and ready to use

    • setup_error: (object)

      Set if the last BMC setup attempt resulted in an error

      • msg: required(string)
      • code: required(integer)
    • close_error: (object)

      Set if the last BMC close attempt resulted in an error

      • msg: required(string)
      • code: required(integer)
    • access_type: (one of DIRECT, FPGA)

      Method of BMC access, only populated if BMC is setup

    • sensor_list: (array of string)

      Supported sensors BMC can read, only populated if BMC is setup

  • fpgas: (array of Fpga)

    Fpgas on this board, only populated after initilization

    Items: Fpga

    • name: required(string)

      FPGA model name

    • dna: required(string)

      FPGA serial number

Close and remove board

URI Parameters

  • board: required(string)

    Board Key

HTTP status code 204

Operation successful

HTTP status code 408

Board is busy with another operation

get post delete

get

Query BMC state

post

Setup BMC

delete

Disconnects the BMC

Query BMC state

URI Parameters

  • board: required(string)

    Board Key

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • is_setup: required(boolean)

    True the BMC is setup and ready to use

  • setup_error: (object)

    Set if the last BMC setup attempt resulted in an error

    • msg: required(string)
    • code: required(integer)
  • close_error: (object)

    Set if the last BMC close attempt resulted in an error

    • msg: required(string)
    • code: required(integer)
  • access_type: (one of DIRECT, FPGA)

    Method of BMC access, only populated if BMC is setup

  • sensor_list: (array of string)

    Supported sensors BMC can read, only populated if BMC is setup

Setup BMC

URI Parameters

  • board: required(string)

    Board Key

Body

Media type: application/json

Type: object

Properties
  • can_change_bitstream: (boolean - default: false)

    If true, allows the setup sequence to program a custom FPGA bitstream to attempt to gain access to the BMC. This will only be done if a compatible bitstream is not already loaded.

HTTP status code 200

Request was successfully submitted, returns updated BMC state. Check the setup_error property for errrors.

Body

Media type: application/json

Type: object

Properties
  • is_setup: required(boolean)

    True the BMC is setup and ready to use

  • setup_error: (object)

    Set if the last BMC setup attempt resulted in an error

    • msg: required(string)
    • code: required(integer)
  • close_error: (object)

    Set if the last BMC close attempt resulted in an error

    • msg: required(string)
    • code: required(integer)
  • access_type: (one of DIRECT, FPGA)

    Method of BMC access, only populated if BMC is setup

  • sensor_list: (array of string)

    Supported sensors BMC can read, only populated if BMC is setup

HTTP status code 400

Invalid request body

HTTP status code 408

Board is busy with another operation

Disconnects the BMC

URI Parameters

  • board: required(string)

    Board Key

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • is_setup: required(boolean)

    True the BMC is setup and ready to use

  • setup_error: (object)

    Set if the last BMC setup attempt resulted in an error

    • msg: required(string)
    • code: required(integer)
  • close_error: (object)

    Set if the last BMC close attempt resulted in an error

    • msg: required(string)
    • code: required(integer)
  • access_type: (one of DIRECT, FPGA)

    Method of BMC access, only populated if BMC is setup

  • sensor_list: (array of string)

    Supported sensors BMC can read, only populated if BMC is setup

HTTP status code 408

Board is busy with another operation

put

put

Modify core voltage for FPGA

Modify core voltage for FPGA

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

Body

Media type: application/json

Type: object

Properties
  • value: required(number)

    Core voltage in Volts

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 204

Operation successful

HTTP status code 400

Invalid request body

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

get

get

Query BMC sensors

Query BMC sensors

URI Parameters

  • board: required(string)

    Board Key

Query Parameters

  • filter: (string)

    Takes a comma separated list of sensors to query. The suppported sensors can be found in parent resources's supported_sensors property. If omitted, all sensors will be returned.

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • sensors: (object)

    Object containing all of the sensor values as properties

  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

Example:

{
  "sensors": {
    "fan_speed": 0,
    "vr_ctrl_temp": 49.5625,
    "vr_pwr_stage_temp0": 44.3125,
    "vr_pwr_stage_temp1": 43.6875,
    "aux_temp0": 41,
    "dimm_temp2": 0,
    "vccint": 0.8,
    "fan_temp": 40,
    "dimm_temp3": 0,
    "input_power": 11.9947,
    "pex_3v3_voltage": 3.364,
    "board_name": "CBU1AEBE",
    "pex_12v_current": 0.625,
    "aux_3v3_voltage": 3.343,
    "aux_temp2": 42,
    "aux_temp1": 41,
    "aux_12v_voltage": 12.337,
    "bmc_version": "1.6",
    "aux_12v_current": 0.343,
    "pex_12v_voltage": 12.421,
    "fpga_temp": 39,
    "dimm_temp0": 0,
    "board_rev": "1.0",
    "dimm_temp1": 0
  }
}

HTTP status code 400

Invalid request query string

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

get

get

Query list of board FPGAs

Query list of board FPGAs

URI Parameters

  • board: required(string)

    Board Key

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • fpgas: required(array of object)

    Items: Fpga

    • name: required(string)

      FPGA model name

    • dna: required(string)

      FPGA serial number

get

get

Query specific board FPGA

Query specific board FPGA

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • name: required(string)

    FPGA model name

  • dna: required(string)

    FPGA serial number

get put

get

EXPERIMENTAL Issue read AXI transaction

put

EXPERIMENTAL Issue write AXI transaction

EXPERIMENTAL Issue read AXI transaction

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

  • axi: required(integer)

    AXI index

  • address: required(string)

    AXI address, as decimal or hex unsigned integer. Default burst addressing mode is FIXED, to switch to INCR mode, append a+ to the address.

Query Parameters

  • cache: (string - default: bm)

    Cache attributes on the AXI transaction; specify the following letters to enable attributes:

    • b : bufferable
    • m : modifiable
    • r : read-alloc
    • w : write-alloc
  • count: (integer - default: 1)

    Number of words in this AXI transaction

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • value: (array of )

    Array of words read by AXI transaction

  • response: (one of OKAY, EXOKAY, SLVERR, DECERR)

    AXI bus response

  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 400

Invalid request query string

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

EXPERIMENTAL Issue write AXI transaction

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

  • axi: required(integer)

    AXI index

  • address: required(string)

    AXI address, as decimal or hex unsigned integer. Default burst addressing mode is FIXED, to switch to INCR mode, append a+ to the address.

Query Parameters

  • cache: (string - default: bm)

    Cache attributes on the AXI transaction; specify the following letters to enable attributes:

    • b : bufferable
    • m : modifiable
    • r : read-alloc
    • w : write-alloc
  • count: (integer - default: 1)

    Number of words in this AXI transaction

Body

Media type: application/json

Type: object

Properties
  • value: required(array of )

    Array of words to write in AXI transaction. If not enough words are provided, ero will be used for the remainder of the words.

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • response: required(one of OKAY, EXOKAY, SLVERR, DECERR)

    AXI bus response

  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 400

Invalid request body or query string

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

get

get

Read FPGA DNA eFuse

Read FPGA DNA eFuse

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • dna: required(string)

    FPGA serial number

HTTP status code 408

Board is busy with another operation

post delete

post

Loads a bitstream in the FPGA configuration memory.

delete

Clears the bitstream from configuration memory.

Loads a bitstream in the FPGA configuration memory.

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

Body

Media type: application/json

Type: object

Properties
  • bitstream: (string)

    The bitstream id to load. The bitstream must have already been uploaded to /bitstream before it can be loaded. If omitted, the default bitstream in flash memory will be loaded.

  • is_partial: (boolean - default: false)

    If true, the bitstream will be loaded as a partial bitstream, which means that configuration memory will not be cleared before loading the bitstream. If false, the bitstream type will be autodetected.

  • disable_part_check: (boolean - default: false)

    Disables the software check that ensures the fpga model matches the part number in the bitstream. Some bitstreams may not load even when this is set, since there can be hardware checks that prevent the fpga from booting with the wrong bitstream.

HTTP status code 200

Request was successfully submitted, returns updated board state. Check the init_error property for errrors.

Body

Media type: application/json

Type: object

Properties
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 204

Operation successful

HTTP status code 408

Board is busy with another operation

Clears the bitstream from configuration memory.

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

HTTP status code 200

Request was successfully submitted, returns updated board state. Check the init_error property for errrors.

Body

Media type: application/json

Type: object

Properties
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 204

Operation successful

HTTP status code 408

Board is busy with another operation

get put

get

Read FPGA SYSMON register

put

Write FPGA SYSMON register

Read FPGA SYSMON register

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

  • reg: required(string)

    Register number, as decimal or hex unsigned integer

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • value: (integer)

    Register Value

  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

Write FPGA SYSMON register

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

  • reg: required(string)

    Register number, as decimal or hex unsigned integer

Body

Media type: application/json

Type: object

Properties
  • value: required(integer)

    Value to write to the SYSMON register

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 204

Operation successful

HTTP status code 400

Invalid request body

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

get

get

Read FPGA current temperature

Read FPGA current temperature

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • min: (number)
  • value: (number)
  • max: (number)
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

get

get

Read FPGA current VCCAUX measurement

Read FPGA current VCCAUX measurement

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • min: (number)
  • value: (number)
  • max: (number)
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

get

get

Read FPGA current VCCBRAM measurement

Read FPGA current VCCBRAM measurement

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • min: (number)
  • value: (number)
  • max: (number)
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

get

get

Read FPGA current VCCINT measurement

Read FPGA current VCCINT measurement

URI Parameters

  • board: required(string)

    Board Key

  • fpga: required(integer)

    FPGA index

HTTP status code 200

Request was successfully submitted, check error property to determine if it completed successfully.

Body

Media type: application/json

Type: object

Properties
  • min: (number)
  • value: (number)
  • max: (number)
  • error: (object)

    Set if there was a hardware error

    • msg: required(string)
    • code: required(integer)

HTTP status code 403

License error

HTTP status code 408

Board is busy with another operation

post

post

Opens and initializes this board. Calling this muliple times will cause a board to be reinitialized.

Opens and initializes this board. Calling this muliple times will cause a board to be reinitialized.

URI Parameters

  • board: required(string)

    Board Key

Body

Media type: application/json

Type: object

HTTP status code 200

Request was successfully submitted, returns updated board state. Check the init_error property for errrors.

Body

Media type: application/json

Type: object

Properties
  • key: required(string)

    Board key for API use

  • is_open: required(boolean)

    True if the board is opened by the OS

  • open_error: (object)

    Set if the last open call on this board resulted in an error

    • msg: required(string)
    • code: required(integer)
  • is_init: required(boolean)

    True if the board has been initialized

  • init_error: (object)

    Set if the last init call on this board resulted in an error

    • msg: required(string)
    • code: required(integer)
  • serial: required(string)

    Board serial string

  • description: required(string)

    Board description string

  • vendor: required(string)

    Board vendor string

  • bmc: required(object)

    BMC status and capabilities

    • is_setup: required(boolean)

      True the BMC is setup and ready to use

    • setup_error: (object)

      Set if the last BMC setup attempt resulted in an error

      • msg: required(string)
      • code: required(integer)
    • close_error: (object)

      Set if the last BMC close attempt resulted in an error

      • msg: required(string)
      • code: required(integer)
    • access_type: (one of DIRECT, FPGA)

      Method of BMC access, only populated if BMC is setup

    • sensor_list: (array of string)

      Supported sensors BMC can read, only populated if BMC is setup

  • fpgas: (array of Fpga)

    Fpgas on this board, only populated after initilization

    Items: Fpga

    • name: required(string)

      FPGA model name

    • dna: required(string)

      FPGA serial number

HTTP status code 408

Board is busy with another operation

post

post

Opens this board if it isn't aleady opened

Opens this board if it isn't aleady opened

URI Parameters

  • board: required(string)

    Board Key

Body

Media type: application/json

Type: object

HTTP status code 200

Request was successfully submitted, returns updated board state. Check the open_error property for errrors.

Body

Media type: application/json

Type: object

Properties
  • key: required(string)

    Board key for API use

  • is_open: required(boolean)

    True if the board is opened by the OS

  • open_error: (object)

    Set if the last open call on this board resulted in an error

    • msg: required(string)
    • code: required(integer)
  • is_init: required(boolean)

    True if the board has been initialized

  • init_error: (object)

    Set if the last init call on this board resulted in an error

    • msg: required(string)
    • code: required(integer)
  • serial: required(string)

    Board serial string

  • description: required(string)

    Board description string

  • vendor: required(string)

    Board vendor string

  • bmc: required(object)

    BMC status and capabilities

    • is_setup: required(boolean)

      True the BMC is setup and ready to use

    • setup_error: (object)

      Set if the last BMC setup attempt resulted in an error

      • msg: required(string)
      • code: required(integer)
    • close_error: (object)

      Set if the last BMC close attempt resulted in an error

      • msg: required(string)
      • code: required(integer)
    • access_type: (one of DIRECT, FPGA)

      Method of BMC access, only populated if BMC is setup

    • sensor_list: (array of string)

      Supported sensors BMC can read, only populated if BMC is setup

  • fpgas: (array of Fpga)

    Fpgas on this board, only populated after initilization

    Items: Fpga

    • name: required(string)

      FPGA model name

    • dna: required(string)

      FPGA serial number

HTTP status code 408

Board is busy with another operation

License

Licenses unlock the full feature set for FPGAs in NextJTAG and are tied to the device DNA. Licenses are preloaded at startup from license files, and can be queried by clients using this API. If license uploading is enabled in the server settings, clients are also able to uploaded missing licenses or delete licenses.

get post

get

Query loaded licenses

post

Upload a new license (requires license upload to be enabled)

Upload a new license (requires license upload to be enabled)

Body

Media type: application/json

Type: object

Properties
  • dna: required(string)

    Device DNA of the license

  • value: required(string)

    Base64 string of the license

HTTP status code 200

License was successfully transfered, check error property to determine if it was successfully parsed.

Body

Media type: application/json

Type: object

Properties
  • license: (object)

    Uploaded license information

    • key: required(string)

      Key for querying the API

    • dna: required(string)

      DNA associated with this license

    • value: required(string)

      License value as base64 string

  • error: (object)

    Set if there was a bitstream parsing error

    • msg: required(string)
    • code: required(integer)

HTTP status code 400

Invalid request body

HTTP status code 404

License upload is not enabled

get delete

get

Query specific bitstream

delete

Delete License

Query specific bitstream

URI Parameters

  • dna: required(string)

    License dna value

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • license: required(object)
    • key: required(string)

      Key for querying the API

    • dna: required(string)

      DNA associated with this license

    • value: required(string)

      License value as base64 string

Delete License

URI Parameters

  • dna: required(string)

    License dna value

HTTP status code 204

Operation successful

HTTP status code 404

License not found or license upload is not enabled

Version

Information about underlying nextjtag library

get

get

Query nextjtag version