NAM Server REST API - Information

Applies to NAM 2019 Service Pack 1

Use GET requests on this endpoint to retrieve basic NAM Server version and configuration information.

GET info

A GET request of the form:

GET https://nam-server-address:port/public/api/info/v1

returns this NAM Server's universally unique identifier (UUID) and version.

Example response:

{
    "uuid": "example-UUID",
    "version": "19.0.1.761"
}

GET version

A GET request of the form:

GET https://nam-server-address:port/public/api/info/v1/version

returns this NAM Server's version information in various formats.

Example response:

{
    "version": "19.0.1.761",
    "name": "rtm",
    "fullName": "NAM Server",
    "longName": "NAM Server 2019 SP1",
    "major": 19,
    "minor": 0,
    "patch": 1,
    "build": 761
}

GET processing

A GET request of the form:

GET https://nam-server-address:port/public/api/info/v1/processing

returns this NAM Server's processing information.

Example response:

{
    "alertTime": 1561459800000,
    "oldestStoredSampleEndTime": 1561458000000,
    "lowerLimit": 1561405397921,
    "upperLimit": -1,
    "queuedTime": 1561459500000,
    "processedTime": 1561459800000
}

GET farm

A GET request of the form:

GET https://nam-server-address:port/public/api/info/v1/farm

returns this NAM Server's farm role.

Example response:

{
    "type": "MASTER",
    "subnodesDesc": "example-subnodes-description",
    "lastProcessedTs": 1561460100000
}

GET access

A GET request of the form:

GET https://nam-server-address:port/public/api/info/v1/access

returns this NAM Server's access configuration (names, ports, and addresses).

Example response:

{
    "hostName": "example-hostname",
    "machineName": "example-machine-name",
    "ports": {
        "80": {
            "port": 80,
            "isSecure": false
        },
        "443": {
            "port": 443,
            "isSecure": true
        }
    },
    "privateAddress": "example-private-address",
    "publicHttpURL": "example-public-http-address",
    "publicHttpsURL": "example-public-https-address"
}

GET all

A GET request of the form:

GET https://nam-server-address:port/public/api/info/v1/all

returns an aggregation of this NAM Server's information. This is an aggregation of all information available from this endpoint in the separate requests described above (info, version, processing, farm role, access).

Example response:

{
    "uuid": "example-UUID",
    "version": "19.0.1.761",
    "versionDescription": {
        "version": "19.0.1.761",
        "name": "rtm",
        "fullName": "NAM Server",
        "longName": "NAM Server 2019 SP1",
        "major": 19,
        "minor": 0,
        "patch": 1,
        "build": 761
    },
    "farmDescription": {
        "type": "MASTER",
        "subnodesDesc": "example-subnodes-description",
        "lastProcessedTs": 1561459800000
    },
    "accessDescription": {
        "hostName": "example-hostname",
        "machineName": "example-machine-name",
        "ports": {
            "80": {
                "port": 80,
                "isSecure": false
            },
            "443": {
                "port": 443,
                "isSecure": true
            }
        },
        "privateAddress": "example-private-address",
        "publicHttpURL": "example-public-http-address",
        "publicHttpsURL": "example-public-https-address"
    },
    "processingData": {
        "alertTime": 1561459800000,
        "oldestStoredSampleEndTime": 1561458000000,
        "lowerLimit": 1561405397921,
        "upperLimit": -1,
        "queuedTime": 1561459500000,
        "processedTime": 1561459800000
    }
}