Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nudge Security Fields API

Manage custom fields and their allowed values.

Nudge Security Fields API is one of 11 APIs that Nudge Security publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.nudgesecurity.io/api/1.0.

2 operations 1 paths 1 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.nudgesecurity.io/api/1.0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nudge Security Fields API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Token) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Fields 2

Manage custom fields and their allowed values.

GET
/fields
Search fields
→ 200
POST
/fields
Create field
body → 201

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is PaginatedList (4 properties). Each schema is shown below with its type and property counts.

PaginatedList
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nudge-security-fields-api-openapi.yml Raw ↑

Other APIs Nudge Security publishes across the network.

Nudge Security Accounts API
Nudge Security App Integrations API
Nudge Security Apps API
Nudge Security Events API
Nudge Security Findings API
Nudge Security Labels API
Nudge Security Notifications API
Nudge Security OAuth Grants API
Nudge Security User Groups API
Nudge Security Users API