Introduction

This is the NetFoundry Network Management Service

Overview

HTTP verbs

NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

Verb	Usage
`GET`	Used to retrieve a resource
`POST`	Used to create a new resource
`PUT`	Used to update an existing resource, full updates only
`PATCH`	Used to update an existing resource, partial updates
`DELETE`	Used to delete an existing resource

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

PATCH

Used to update an existing resource, partial updates

DELETE

Used to delete an existing resource

HTTP status codes

NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

Status code	Usage
`200 OK`	The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.
`201 Created`	The request has been fulfilled and resulted in a new resource being created.
`202 Accepted`	The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services.
`204 No Content`	The server successfully processed the request, but is not returning any content.
`400 Bad Request`	The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
`401 Unauthorized`	The request lacks valid authentication credentials for the target resource.
`403 Forbidden`	The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource.
`404 Not Found`	The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

200 OK

The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

201 Created

The request has been fulfilled and resulted in a new resource being created.

202 Accepted

The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

Pagination

Paginated services will accept the following optional request parameters:

Table 1. Request parameters
Path	Type	Optional	Description
page	Integer	true	Page you want to retrieve, 0 indexed and defaults to 0.
size	Integer	true	Size of the page you want to retrieve, defaults to 1000.
sort	String	true	Properties that should be sorted by in the format `property,property(,ASC\|DESC)`. Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. `?sort=firstname&sort=lastname,asc`.

Pagination response has following structure:

Table 2. Response structure
Path	Type	Optional	Description
content	Array[Object]	false	Actual items.
totalElements	Integer	false	Total count.
totalPages	Integer	false	Total pages with current page size.
last	Boolean	false	If this page is the last one.
numberOfElements	Integer	false	Actual size of content array (number of items).
first	Boolean	false	If this page is the first one.
sort	Object	true	Sort information object.
size	Integer	false	Requested size of the page.
number	Integer	false	Page number.
empty	boolean	false	If this page is empty.

Resources

Configurations

Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/configurations/create-configuration/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/configurations/get-groups/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/configurations/get-configuration/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/configurations/update-configuration/auto-section.adoc[]

Synchronizations

Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/synchronizations/delete-sync-connection/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/synchronizations/edit-sync-connection/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/synchronizations/get-sync-connection/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/synchronizations/get-syncs-for-network/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/synchronizations/run-sync-process/auto-section.adoc[] Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/synchronizations/setup-sync-provider/auto-section.adoc[]

Processes

Unresolved directive in index.adoc - include::/Users/prashantsavadi/git/clientsync-network-status-check/target/generated-snippets/processs/get-sync-processes/auto-section.adoc[]

NetFoundry Network Management V2 Service Guide