SpaceONE APIs
Latest Version
Search
K

Protocol

Package : spaceone.api.notification.v1

Protocol

Protocol Methods:

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

Field
Type
Required
Description
name
string
The name of Protocol. It can have a maximum of 255 characters.
plugin_info
Describe a Plugin information for protocol that include was used plugin, specific version, schema etc.
tags
The tags for protocol.
domain_id
string
The ID of domain to which the Protocol belongs.

GetProtocolRequest

Field
Type
Required
Description
protocol_id
string
The ID of Protocol.
domain_id
string
The ID of domain to which the Protocol belongs.
only
list of string
The list of the Protocol information column you want to be returned. It must be specified in the ProtocolInfo.

PluginInfo

Field
Type
Description
plugin_id
string
The ID of plugin set in the Protocol.
version
string
The version of plugin.
options
The Options that contains information about using plugin.
secret_id
string
The ID of the Secret containing encrypted data to be used in the plugin.
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.
upgrade_mode
  • NONE
  • AUTO
  • MANUAL
Auto upgrade for plugin.If the upgrade_mode is AUTO, check the latest plugin version when running the plugin, and if a new version is existed, replace the plugin and then run it.

PluginRequest

Field
Type
Required
Description
plugin_id
string
The ID of plugin.
version
string
The version of plugin.
options
The Options that contains information about using plugin.
secret_data
The data for using plugin if necessary. This data is encrypted and stored in the Secret service.
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.
upgrade_mode
  • NONE
  • AUTO
  • MANUAL
Auto upgrade feature for plugin.If the upgrade mode is AUTO, check the latest plugin version when running the plugin, and if a new version is existed, replace the plugin and then run it.

ProtocolInfo

Field
Type
Description
protocol_id
string
The ID of Protocol.
name
string
The name of Protocol.
state
  • NONE
  • ENABLED
  • DISABLED
The state of Protocol.ENABLED or DISABLED only.
protocol_type
  • PROTOCOL_TYPE_NONE
  • INTERNAL
  • EXTERNAL
{}
resource_type
string
Resource type for Protocol. Currently only identity.Project or identity.User can be set.
capability
The capability information for the Protocol. It included supported schema for the Protocol.
plugin_info
the plugin information set in Protocol.
tags
The tags for protocol.
domain_id
string
The ID of domain to which the Protocol belongs.
created_at
string
Protocol creation time.

ProtocolQuery

Field
Type
Required
Description
query
Query format provided by SpaceONE. Please check the link for more information.
protocol_id
string
The ID of Protocol.
name
string
The name of Protocol.
state
  • NONE
  • ENABLED
  • DISABLED
The state of Protocol. ENABLED or DISABLED only.
protocol_type
  • PROTOCOL_TYPE_NONE
  • INTERNAL
  • EXTERNAL
The type of Protocol. INTERNAL or EXTERNAL only.
domain_id
string
The ID of domain to which the Protocol belongs.

ProtocolRequest

Field
Type
Required
Description
protocol_id
string
The ID of Protocol.
domain_id
string
The ID of domain to which the Protocol belongs.

ProtocolStatQuery

Field
Type
Required
Description
query
Statistics Query format provided by SpaceONE. Please check the link for more information.
domain_id
string
The ID of domain to which the Protocol belongs.

ProtocolsInfo

Field
Type
Description
results
List of queried protocols.
total_count
int32
Total counts of queried Protocols.

UpdateProtocolPluginRequest

Field
Type
Required
Description
protocol_id
string
The ID of Protocol.
version
string
The version of plugin you want to update. Version means the tags of plugin container image in repository that specific market place.
options
The Options that contains information about using plugin.
domain_id
string
The ID of domain to which the Protocol belongs.

UpdateProtocolRequest

Field
Type
Required
Description
protocol_id
string
The ID of Protocol.
name
string
The Name of Protocol. It can have a maximum of 255 characters.
tags
The tags for protocol. When updating, existing tag information is deleted all and will be updated with new.
domain_id
string
The ID of domain to which the Protocol belongs.