Network profiles schema

service.profile.network.graphqls

This API is available in Enterprise and AWS editions only.

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.

API Endpoints
https://your-server-address/api/gql

Queries

listGlobalNetworkProfiles

Description

Returns all network profiles that are available globally across all projects

Response

Returns [NetworkProfileConfig!]!

Example

Query
query listGlobalNetworkProfiles {
  listGlobalNetworkProfiles {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Response
{
  "data": {
    "listGlobalNetworkProfiles": [
      {
        "profileName": "<id>",
        "global": "<boolean>",
        "projectId": "<id>",
        "configurations": [NetworkHandlerConfig]
      }
    ]
  }
}
Queries

listProjectNetworkProfiles

Description

Returns all network profiles configured for the specified project (also includes global profiles if they exist)

Response

Returns [NetworkProfileConfig!]!

Arguments
Name Description
projectId - ID!

Example

Query
query listProjectNetworkProfiles($projectId: ID!) {
  listProjectNetworkProfiles(projectId: $projectId) {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Variables
{"projectId": "<id>"}
Response
{
  "data": {
    "listProjectNetworkProfiles": [
      {
        "profileName": "<id>",
        "global": "<boolean>",
        "projectId": "<id>",
        "configurations": [NetworkHandlerConfig]
      }
    ]
  }
}

Mutations

copyGlobalNetworkProfile

Description

Creates a copy of an existing network profile under a new name that is available globally across all projects

Response

Returns a NetworkProfileConfig!

Arguments
Name Description
profileName - ID!
newProfileName - ID!

Example

Query
mutation copyGlobalNetworkProfile(
  $profileName: ID!,
  $newProfileName: ID!
) {
  copyGlobalNetworkProfile(
    profileName: $profileName,
    newProfileName: $newProfileName
  ) {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Variables
{"profileName": "<id>", "newProfileName": "<id>"}
Response
{
  "data": {
    "copyGlobalNetworkProfile": {
      "profileName": "<id>",
      "global": "<boolean>",
      "projectId": "<id>",
      "configurations": [NetworkHandlerConfig]
    }
  }
}
Mutations

copyProjectNetworkProfile

Description

Creates a copy of an existing network profile under a new name in the specified project

Response

Returns a NetworkProfileConfig!

Arguments
Name Description
projectId - ID!
profileName - ID!
newProfileName - ID!

Example

Query
mutation copyProjectNetworkProfile(
  $projectId: ID!,
  $profileName: ID!,
  $newProfileName: ID!
) {
  copyProjectNetworkProfile(
    projectId: $projectId,
    profileName: $profileName,
    newProfileName: $newProfileName
  ) {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Variables
{"projectId": "<id>", "profileName": "<id>", "newProfileName": "<id>"}
Response
{
  "data": {
    "copyProjectNetworkProfile": {
      "profileName": "<id>",
      "global": "<boolean>",
      "projectId": "<id>",
      "configurations": [NetworkHandlerConfig]
    }
  }
}
Mutations

createGlobalNetworkProfile

Description

Creates a new network profile that is available globally across all projects

Response

Returns a NetworkProfileConfig!

Arguments
Name Description
configuration - NetworkProfileConfigInput!

Example

Query
mutation createGlobalNetworkProfile($configuration: NetworkProfileConfigInput!) {
  createGlobalNetworkProfile(configuration: $configuration) {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Variables
{"configuration": NetworkProfileConfigInput}
Response
{
  "data": {
    "createGlobalNetworkProfile": {
      "profileName": "<id>",
      "global": "<boolean>",
      "projectId": "<id>",
      "configurations": [NetworkHandlerConfig]
    }
  }
}
Mutations

createProjectNetworkProfile

Description

Creates a new network profile in the specified project

Response

Returns a NetworkProfileConfig!

Arguments
Name Description
projectId - ID!
configuration - NetworkProfileConfigInput!

Example

Query
mutation createProjectNetworkProfile(
  $projectId: ID!,
  $configuration: NetworkProfileConfigInput!
) {
  createProjectNetworkProfile(
    projectId: $projectId,
    configuration: $configuration
  ) {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Variables
{
  "projectId": "<id>",
  "configuration": NetworkProfileConfigInput
}
Response
{
  "data": {
    "createProjectNetworkProfile": {
      "profileName": "<id>",
      "global": "<boolean>",
      "projectId": "<id>",
      "configurations": [NetworkHandlerConfig]
    }
  }
}
Mutations

deleteGlobalNetworkProfile

Description

Deletes a global network profile

Response

Returns a Boolean!

Arguments
Name Description
profileName - ID!

Example

Query
mutation deleteGlobalNetworkProfile($profileName: ID!) {
  deleteGlobalNetworkProfile(profileName: $profileName)
}
Variables
{"profileName": "<id>"}
Response
{
  "data": {
    "deleteGlobalNetworkProfile": "<boolean>"
  }
}
Mutations

deleteProjectNetworkProfile

Description

Deletes a network profile from the specified project

Response

Returns a Boolean!

Arguments
Name Description
projectId - ID!
profileName - ID!

Example

Query
mutation deleteProjectNetworkProfile(
  $projectId: ID!,
  $profileName: ID!
) {
  deleteProjectNetworkProfile(
    projectId: $projectId,
    profileName: $profileName
  )
}
Variables
{"projectId": "<id>", "profileName": "<id>"}
Response
{
  "data": {
    "deleteProjectNetworkProfile": "<boolean>"
  }
}
Mutations

updateGlobalNetworkProfile

Description

Updates an existing global network profile

Response

Returns a NetworkProfileConfig!

Arguments
Name Description
configuration - NetworkProfileConfigInput!

Example

Query
mutation updateGlobalNetworkProfile($configuration: NetworkProfileConfigInput!) {
  updateGlobalNetworkProfile(configuration: $configuration) {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Variables
{"configuration": NetworkProfileConfigInput}
Response
{
  "data": {
    "updateGlobalNetworkProfile": {
      "profileName": "<id>",
      "global": "<boolean>",
      "projectId": "<id>",
      "configurations": [NetworkHandlerConfig]
    }
  }
}
Mutations

updateProjectNetworkProfile

Description

Updates an existing network profile in the specified project

Response

Returns a NetworkProfileConfig!

Arguments
Name Description
projectId - ID!
configuration - NetworkProfileConfigInput!

Example

Query
mutation updateProjectNetworkProfile(
  $projectId: ID!,
  $configuration: NetworkProfileConfigInput!
) {
  updateProjectNetworkProfile(
    projectId: $projectId,
    configuration: $configuration
  ) {
    profileName
    global
    projectId
    configurations {
      ...NetworkHandlerConfigFragment
    }
  }
}
Variables
{
  "projectId": "<id>",
  "configuration": NetworkProfileConfigInput
}
Response
{
  "data": {
    "updateProjectNetworkProfile": {
      "profileName": "<id>",
      "global": "<boolean>",
      "projectId": "<id>",
      "configurations": [NetworkHandlerConfig]
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"<id>"
Types

NetworkHandlerAuthType

Description

SSH network handler authentication type

Values
Enum Value Description

PASSWORD

PUBLIC_KEY

AGENT
Example
"PASSWORD"
Types

NetworkHandlerConfig

Description

SSH/SSL network handler config. Name without prefix only for backward compatibility

Fields
Field Name Description
id - ID!
enabled - Boolean! Defines if the network handler is enabled
authType - NetworkHandlerAuthType! SSH network handler auth type use properties
userName - String SSH network handler user name
password - String SSH network handler user password
key - String SSH network handler private key use secured properties
savePassword - Boolean! A flag that indicates if the password should be saved in the secure storage
properties - Object! Network handler properties (name/value)
secureProperties - Object! Network handler secure properties (name/value). Used for passwords and keys
Example
{
  "id": "<id>",
  "enabled": "<boolean>",
  "authType": "PASSWORD",
  "userName": "<string>",
  "password": "<string>",
  "key": "<string>",
  "savePassword": "<boolean>",
  "properties": "<object>",
  "secureProperties": "<object>"
}
Types

NetworkHandlerConfigInput

Fields
Input Field Description
id - ID!
enabled - Boolean Defines if the network handler should be enabled
userName - String Sets user name for the network handler (SSH)
password - String Sets user password for the network handler (SSH)
savePassword - Boolean Sets a flag that indicates if the password should be saved in the secure storage
properties - Object Network handler properties (name/value)
secureProperties - Object Network handler secure properties (name/value). Used for passwords and keys
Example
{
  "id": "<id>",
  "enabled": "<boolean>",
  "userName": "<string>",
  "password": "<string>",
  "savePassword": "<boolean>",
  "properties": "<object>",
  "secureProperties": "<object>"
}
Types

NetworkProfileConfig

Description

Represents a reusable network profile containing one or more network handler configurations (e.g. SSH, SSL) within a project

Fields
Field Name Description
profileName - ID! Unique profile name within a project
global - Boolean! Indicates whether this profile is available globally across all projects
projectId - ID The project ID to which this profile belongs (null if global)
configurations - [NetworkHandlerConfig!]! Collection of network handler configurations associated with this profile
Example
{
  "profileName": "<id>",
  "global": "<boolean>",
  "projectId": "<id>",
  "configurations": [NetworkHandlerConfig]
}
Types

NetworkProfileConfigInput

Description

Input object used to create or update a network profile

Fields
Input Field Description
profileName - ID! Unique profile name within a project
configurations - [NetworkHandlerConfigInput!]! Collection of network handler configurations to be stored in the profile
Example
{
  "profileName": "<id>",
  "configurations": [NetworkHandlerConfigInput]
}
Types

Object

Description

Any object (JSON)

Example
"<object>"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"<string>"
Documentation by Anvil SpectaQL