Helix Artifacts Backend information endpoints

This section describes the Helix Artifacts service endpoints.

Backend status

Description

GET http://localhost:1600/api/v1/status

A status check for the Helix Artifacts configuration.

Usage example

Get the status of the Helix Artifacts configuration status:

curl http://localhost:1600/api/v1/status

Helix Artifacts responds with:

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "data": [
    {
    "name": "config",
    "title": "Configuration",
    "staus": "SUCCESS"
    }
  [
}    

Backend Plugin registration

Description

GET http://localhost:1600/api/v1/registration/plugin

Checks for plugin registrations.

Usage example

Check for your Helix Artifacts plugin registrations:

curl -H "X-Auth-Token: <YOUR-AUTH-TOKEN>" http://localhost:1600/api/v1/registration/plugin

Helix Artifacts responds with:

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "data": {
    "MAVEN":{
      "type": "MAVEN",
      "title": "Maven",
      "url": "http://helix-artifacts:1603"
      "defaultFilter":"*.pom",
      "heartbeat":1619622948121
      }
    }
  [
}    

Backend build version

Description

GET http://localhost:1600/api/v1/build

Returns current build version of the Helix Artifacts service.

Usage example

Get the build version of the Helix Artifacts service:

curl http://localhost:1600/api/v1/build

Helix Artifacts responds with:

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "data": [
    {
      "0.1.2121146"
    }
  [
}