open-nomad/website/source/api/system.html.md

1.6 KiB

layout page_title sidebar_current description
api System - HTTP API api-system The /system endpoints are used for system maintenance.

System HTTP API

The /system endpoints are used to for system maintenance and should not be necessary for most users.

Force GC

This endpoint initializes a garbage collection of jobs, evaluations, allocations, and nodes. This is an asynchronous operation.

Method Path Produces
PUT /v1/system/gc application/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking Queries ACL Required
NO management

Sample Request

$ curl \
    --request PUT \
    https://localhost:4646/v1/system/gc

Reconcile Summaries

This endpoint reconciles the summaries of all registered jobs.

Method Path Produces
PUT /v1/system/reconcile/summaries application/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking Queries ACL Required
NO management

Sample Request

$ curl \
    https://localhost:4646/v1/system/reconcile/summaries