Posture Check

List Posture Checks

get

Authorizations

Query parameters

networkstringRequired

Network ID

idstringOptional

Posture Check ID to fetch a specific check

Responses

200

application/json

attributestring · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

descriptionstringOptional

idstringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

severityinteger · enumOptionalPossible values:

statusbooleanOptional

updated_atstringOptional

valuesstring[]Optional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/v1/posture_check

GET /api/v1/posture_check?network=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "attribute": "os",
    "created_at": "text",
    "created_by": "text",
    "description": "text",
    "id": "text",
    "name": "text",
    "network_id": "all_networks",
    "severity": 0,
    "status": true,
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "updated_at": "text",
    "user_groups": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "values": [
      "text"
    ]
  }
]

Create Posture Check

post

Authorizations

Body

attributestring · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

descriptionstringOptional

idstringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

severityinteger · enumOptionalPossible values:

statusbooleanOptional

updated_atstringOptional

valuesstring[]Optional

Responses

200

application/json

attributestring · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

descriptionstringOptional

idstringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

severityinteger · enumOptionalPossible values:

statusbooleanOptional

updated_atstringOptional

valuesstring[]Optional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post/api/v1/posture_check

POST /api/v1/posture_check HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "attribute": "os",
  "created_at": "text",
  "created_by": "text",
  "description": "text",
  "id": "text",
  "name": "text",
  "network_id": "all_networks",
  "severity": 0,
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text",
  "user_groups": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "values": [
    "text"
  ]
}

{
  "attribute": "os",
  "created_at": "text",
  "created_by": "text",
  "description": "text",
  "id": "text",
  "name": "text",
  "network_id": "all_networks",
  "severity": 0,
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text",
  "user_groups": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "values": [
    "text"
  ]
}

Update Posture Check

put

Authorizations

Body

attributestring · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

descriptionstringOptional

idstringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

severityinteger · enumOptionalPossible values:

statusbooleanOptional

updated_atstringOptional

valuesstring[]Optional

Responses

200

application/json

attributestring · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

descriptionstringOptional

idstringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

severityinteger · enumOptionalPossible values:

statusbooleanOptional

updated_atstringOptional

valuesstring[]Optional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

put/api/v1/posture_check

PUT /api/v1/posture_check HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "attribute": "os",
  "created_at": "text",
  "created_by": "text",
  "description": "text",
  "id": "text",
  "name": "text",
  "network_id": "all_networks",
  "severity": 0,
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text",
  "user_groups": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "values": [
    "text"
  ]
}

{
  "attribute": "os",
  "created_at": "text",
  "created_by": "text",
  "description": "text",
  "id": "text",
  "name": "text",
  "network_id": "all_networks",
  "severity": 0,
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text",
  "user_groups": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "values": [
    "text"
  ]
}

Delete Posture Check

delete

Authorizations

Query parameters

idstringRequired

Posture Check ID

Responses

200

application/json

attributestring · enumOptionalPossible values:

created_atstringOptional

created_bystringOptional

descriptionstringOptional

idstringOptional

namestringOptional

network_idstring · enumOptionalPossible values:

severityinteger · enumOptionalPossible values:

statusbooleanOptional

updated_atstringOptional

valuesstring[]Optional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete/api/v1/posture_check

DELETE /api/v1/posture_check?id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "attribute": "os",
  "created_at": "text",
  "created_by": "text",
  "description": "text",
  "id": "text",
  "name": "text",
  "network_id": "all_networks",
  "severity": 0,
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text",
  "user_groups": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "values": [
    "text"
  ]
}

List Posture Checks Available Attributes

get

Authorizations

Responses

200

application/json

codeintegerOptional

messagestringOptional

responseanyOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/v1/posture_check/attrs

GET /api/v1/posture_check/attrs HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

List Posture Check violated Nodes

get

Authorizations

Query parameters

networkstringRequired

Network ID

usersstringOptional

If 'true', list violated users instead of nodes

Responses

200

application/json

additional_rag_ipsstring[]Optional

addressstringOptional

address6stringOptional

allowedipsstring[]Optional

auto_assign_gwbooleanOptional

connectedbooleanOptional

countrystringOptional

defaultaclstringOptional

== PRO ==

dnsonbooleanOptional

egressgatewaynatenabledbooleanOptional

egressgatewayrangesstring[]Optional

expdatetimeinteger · int64Optional

failed_over_bystringOptional

hostidstring · min: 5Required

idstring · min: 5Required

ingressdnsstringOptional

ingressmtuintegerOptional

ingresspersistentkeepaliveintegerOptional

internetgw_node_idstringOptional

is_auto_relaybooleanOptional

is_fail_overbooleanOptional

is_gwbooleanOptional

is_staticbooleanOptional

is_user_nodebooleanOptional

isegressgatewaybooleanOptional

isingressgatewaybooleanOptional

isinternetgatewaybooleanOptional

isrelaybooleanOptional

isrelayedbooleanOptional

last_evaluated_atstringOptional

lastcheckininteger · int64Optional

lastmodifiedinteger · int64Optional

lastpeerupdateinteger · int64Optional

localaddressstringOptional

locationstringOptional

metadatastringOptional

networkstringOptional

networkrangestringOptional

networkrange6stringOptional

pendingdeletebooleanOptional

posture_check_violation_severity_levelinteger · enumOptionalPossible values:

relayedbystringOptional

AutoRelayedBy uuid.UUID json:"auto_relayed_by"

relaynodesstring[]Optional

serverstringOptional

statusstring · enumOptionalPossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/v1/posture_check/violations

GET /api/v1/posture_check/violations?network=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "additional_rag_ips": [
      "text"
    ],
    "address": "text",
    "address6": "text",
    "allowedips": [
      "text"
    ],
    "auto_assign_gw": true,
    "auto_relayed_peers": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "connected": true,
    "country": "text",
    "defaultacl": "text",
    "dnson": true,
    "egressgatewaynatenabled": true,
    "egressgatewayranges": [
      "text"
    ],
    "egressgatewayranges_with_metric": [
      {
        "nat": true,
        "nat_mode": "virtual_nat",
        "network": "text",
        "route_metric": 1,
        "virtual_network": "text"
      }
    ],
    "expdatetime": 1,
    "fail_over_peers": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "failed_over_by": "text",
    "hostid": "text",
    "id": "text",
    "inet_node_req": {
      "inet_node_client_ids": [
        "text"
      ]
    },
    "ingressdns": "text",
    "ingressmtu": 1,
    "ingresspersistentkeepalive": 1,
    "internetgw_node_id": "text",
    "is_auto_relay": true,
    "is_fail_over": true,
    "is_gw": true,
    "is_static": true,
    "is_user_node": true,
    "isegressgateway": true,
    "isingressgateway": true,
    "isinternetgateway": true,
    "isrelay": true,
    "isrelayed": true,
    "last_evaluated_at": "text",
    "lastcheckin": 1,
    "lastmodified": 1,
    "lastpeerupdate": 1,
    "localaddress": "text",
    "location": "text",
    "metadata": "text",
    "network": "text",
    "networkrange": "text",
    "networkrange6": "text",
    "pendingdelete": true,
    "posture_check_violation_severity_level": 0,
    "posture_check_violations": [
      {
        "attribute": "text",
        "check_id": "text",
        "message": "text",
        "name": "text",
        "severity": 0
      }
    ],
    "relayedby": "text",
    "relaynodes": [
      "text"
    ],
    "server": "text",
    "static_node": {
      "address": "text",
      "address6": "text",
      "allowed_ips": [
        "text"
      ],
      "client_version": "text",
      "clientid": "text",
      "country": "text",
      "deniednodeacls": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "device_id": "text",
      "device_name": "text",
      "dns": "text",
      "enabled": true,
      "extraallowedips": [
        "text"
      ],
      "ingressgatewayendpoint": "text",
      "ingressgatewayid": "text",
      "jit_expires_at": "text",
      "kernel_version": "text",
      "last_evaluated_at": "text",
      "lastmodified": 1,
      "location": "text",
      "network": "text",
      "os": "text",
      "os_family": "text",
      "os_version": "text",
      "ownerid": "text",
      "postdown": "text",
      "postup": "text",
      "posture_check_violation_severity_level": 0,
      "posture_check_violations": [
        {
          "attribute": "text",
          "check_id": "text",
          "message": "text",
          "name": "text",
          "severity": 0
        }
      ],
      "privatekey": "text",
      "public_endpoint": "text",
      "publickey": "text",
      "remote_access_client_id": "text",
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "status": "online",
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
]

PreviousAuto Relay NextTAG

Last updated 5 months ago

Was this helpful?