API Clients

/api/v2/apiclients/{id} 📋 Copied! Get API Client Details ▼

Parameters

Name Description
id * Numeric ID of the API Client.
Type: integer (path)

Responses

Code Description
200

API Client data.

Media type: application/json

Example Value:

{
  "basicAuthViaSecrets": true,
  "name": "string",
  "apiClientAuthType": "NONE",
  "headerParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "authParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "serverURL": "string",
  "payload": "string",
  "httpMethod": "string",
  "failureRegexBody": "string",
  "username": "string",
  "password": "string",
  "tokenEndpointForOAuth2": "string",
  "oauth2Scopes": "string",
  "id": 0,
  "projects": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}
404

Resource was not found.

Media type: application/json

Example Value:

{
  "basicAuthViaSecrets": true,
  "name": "string",
  "apiClientAuthType": "NONE",
  "headerParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "authParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "serverURL": "string",
  "payload": "string",
  "httpMethod": "string",
  "failureRegexBody": "string",
  "username": "string",
  "password": "string",
  "tokenEndpointForOAuth2": "string",
  "oauth2Scopes": "string",
  "id": 0,
  "projects": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}
/api/v2/apiclients/{id} 📋 Copied! Get API Client Details ▼

Parameters

Name Description
id * Numeric ID of the API Client.
Type: integer (path)

Request body *

{
    "basicAuthViaSecrets": true,
    "name": "string",
    "apiClientAuthType": "NONE",
    "headerParams": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
    },
    "authParams": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
    },
    "serverURL": "string",
    "payload": "string",
    "httpMethod": "string",
    "failureRegexBody": "string",
    "username": "string",
    "password": "string",
    "tokenEndpointForOAuth2": "string",
    "oauth2Scopes": "string",
    "id": 0
}

Responses

Code Description
200 API Client was updated successfully.
404 Resource was not found.
/api/v2/apiclients/{id} 📋 Copied! Get API Client Details ▼

Parameters

Name Description
id * Numeric ID of the API Client.
Type: integer (path)

Responses

Code Description
200 API Client was deleted successfully.
404 Resource was not found.
409 Resource cannot be deleted.
/api/v2/apiclients 📋 Copied! Get API Client Details ▼

Parameters

Name Description
page The page to list entries.
Type: string (query)
Default value: 0
size The page size for listing entries.
Type: string (query)
Default value: 20
sort The sort type for listing entries.
Type: string (query)
prj The project list for filtering entries.
Type: string (query)
start The start timestamp for listing entries.
Type: string (query)
end The end timestamp for listing entries.
Type: string (query)
search The search text for listing entries.
Type: string (query)

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "totalElements": 0,
  "totalPages": 0,
  "number": 0,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string",
      "projects": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    }
  ],
  "first": true,
  "last": true,
  "pageable": {
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 0,
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "empty": true
}
/api/v2/apiclients 📋 Copied! Get API Client Details ▼

Parameters

No parameters

Request body *

{
  "basicAuthViaSecrets": true,
  "name": "string",
  "apiClientAuthType": "NONE",
  "headerParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "authParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "serverURL": "string",
  "payload": "string",
  "httpMethod": "string",
  "failureRegexBody": "string",
  "username": "string",
  "password": "string",
  "tokenEndpointForOAuth2": "string",
  "oauth2Scopes": "string"
}

Responses

Code Description
201

ID of the API Client.

Media type: application/json

Example Value:

{
  "id": 0
}
409

Name needs to be unique.

Media type: application/json

Example Value:

{
  "id": 0
}