Protocol

Package : spaceone.api.notification.v1

Protocol

Protocol Methods:

NO

Method

Request Type

Response Type

Description

1

Creates a new Protocol.Protocol is the definition of which method to use when dispatching the Notifications through a Channel.When creating a protocol, you must specify the plugins provided from the repository, and you must also set the credentials to be set in the plugin if necessary.

2

Updates a Protocol information.Update methods can update name, tags only. If you want to update plugin version or options, you can use update_plugin method.

3

Updates a plugin for Protocol.This method is usually used when redeploying a deployed plugin container to a new version.

4

Enables a Protocol.If the disabled Protocol is enabled, the Protocol can be used again and the notification can be dispatched.

5

Disables a Protocol.If you disable the Protocol, the notification will not be dispatched, even if they are created.

6

Delete the protocol.If there is even one channel using the protocol, it cannot be deleted.

7

Gets a single Protocol.

8

Lists the specified Protocols.Can search information using the query format provided by SpaceONE.Detailed information about Query format can be checked in the Search Query pages.

9

create

POST /notification/v1/protocols

Creates a new Protocol.Protocol is the definition of which method to use when dispatching the Notifications through a Channel.When creating a protocol, you must specify the plugins provided from the repository, and you must also set the credentials to be set in the plugin if necessary.

Type

Message

Request

Response

update

PUT /notification/v1/protocol/{protocol_id}

Updates a Protocol information.Update methods can update name, tags only. If you want to update plugin version or options, you can use update_plugin method.

Type

Message

Request

Response

update_plugin

PUT /notification/v1/protocol/{protocol_id}/plugin

Updates a plugin for Protocol.This method is usually used when redeploying a deployed plugin container to a new version.

Type

Message

Request

Response

enable

PUT /notification/v1/protocol/{protocol_id}/enable

Enables a Protocol.If the disabled Protocol is enabled, the Protocol can be used again and the notification can be dispatched.

Type

Message

Request

Response

disable

PUT /notification/v1/protocol/{protocol_id}/disable

Disables a Protocol.If you disable the Protocol, the notification will not be dispatched, even if they are created.

Type

Message

Request

Response

delete

DELETE /notification/v1/protocol/{protocol_id}

Delete the protocol.If there is even one channel using the protocol, it cannot be deleted.

Type

Message

Request

Response

get

GET /notification/v1/protocol/{protocol_id}

Gets a single Protocol.

Type

Message

Request

Response

list

GET /notification/v1/protocols

POST /notification/v1/protocols/search

Lists the specified Protocols.Can search information using the query format provided by SpaceONE.Detailed information about Query format can be checked in the Search Query pages.

Type

Message

Request

Response

stat

POST /notification/v1/protocols/stat

Type

Message

Request

Response

Message

CreateProtocolRequest

No

Field

Type

Required

Description

1

name

string

The name of Protocol. It can have a maximum of 255 characters.

2

plugin_info

Describe a Plugin information for protocol that include was used plugin, specific version, schema etc.

3

tags

The tags for protocol.

4

domain_id

string

The ID of domain to which the Protocol belongs.

GetProtocolRequest

No

Field

Type

Required

Description

1

protocol_id

string

The ID of Protocol.

2

domain_id

string

The ID of domain to which the Protocol belongs.

3

only

list of string

The list of the Protocol information column you want to be returned. It must be specified in the ProtocolInfo.

PluginInfo

No

Field

Type

Description

1

plugin_id

string

The ID of plugin set in the Protocol.

2

version

string

The version of plugin.

3

options

The Options that contains information about using plugin.

4

secret_id

string

The ID of the Secret containing encrypted data to be used in the plugin.

5

metadata

The metadata of plugin. It includes schema for the data that must be set for the Channel when creating the Channel using a Protocol.The schema follows the JSON Schema format.

PluginRequest

No

Field

Type

Required

Description

1

plugin_id

string

The ID of plugin.

2

version

string

The version of plugin.

3

options

The Options that contains information about using plugin.

4

secret_data

The data for using plugin if necessary. This data is encrypted and stored in the Secret service.

5

schema

string

The name of schema.When the secret_data is stored in the Secret service, it can be set with schema if the schema is existed.The schema is provided through the Repository service.

ProtocolInfo

No

Field

Type

Description

1

protocol_id

string

The ID of Protocol.

2

name

string

The name of Protocol.

3

state

  • NONE

  • ENABLED

  • DISABLED

The state of Protocol.ENABLED or DISABLED only.

4

protocol_type

  • PROTOCOL_TYPE_NONE

  • INTERNAL

  • EXTERNAL

{}

5

resource_type

string

Resource type for Protocol. Currently only identity.Project or identity.User can be set.

6

capability

The capability information for the Protocol. It included supported schema for the Protocol.

7

plugin_info

the plugin information set in Protocol.

8

tags

The tags for protocol.

9

domain_id

string

The ID of domain to which the Protocol belongs.

10

created_at

string

Protocol creation time.

ProtocolQuery

No

Field

Type

Required

Description

1

query

Query format provided by SpaceONE. Please check the link for more information.

2

protocol_id

string

The ID of Protocol.

3

name

string

The name of Protocol.

4

state

  • NONE

  • ENABLED

  • DISABLED

The state of Protocol. ENABLED or DISABLED only.

5

protocol_type

  • PROTOCOL_TYPE_NONE

  • INTERNAL

  • EXTERNAL

The type of Protocol. INTERNAL or EXTERNAL only.

6

domain_id

string

The ID of domain to which the Protocol belongs.

ProtocolRequest

No

Field

Type

Required

Description

1

protocol_id

string

The ID of Protocol.

2

domain_id

string

The ID of domain to which the Protocol belongs.

ProtocolStatQuery

No

Field

Type

Required

Description

1

query

Statistics Query format provided by SpaceONE. Please check the link for more information.

2

domain_id

string

The ID of domain to which the Protocol belongs.

ProtocolsInfo

No

Field

Type

Description

1

results

List of queried protocols.

2

total_count

Total counts of queried Protocols.

UpdateProtocolPluginRequest

No

Field

Type

Required

Description

1

protocol_id

string

The ID of Protocol.

2

version

string

The version of plugin you want to update. Version means the tags of plugin container image in repository that specific market place.

3

options

The Options that contains information about using plugin.

4

domain_id

string

The ID of domain to which the Protocol belongs.

UpdateProtocolRequest

No

Field

Type

Required

Description

1

protocol_id

string

The ID of Protocol.

2

name

string

The Name of Protocol. It can have a maximum of 255 characters.

3

tags

The tags for protocol. When updating, existing tag information is deleted all and will be updated with new.

4

domain_id

string

The ID of domain to which the Protocol belongs.

Last updated