Skip to main contentIBM Video Streaming Developers

Mutation

The Mutation type represents all the mutable entry points to the API.

type Mutation {
    # Create new location.
    # Authorization: must be at least ADMIN.
    # Returns created location.
    locationCreate(
        # Batch input for location creation.
        config: BatchLocationInput!
    ): Location!
    # Batch configuration of a location.
    # Authorization: must be at least ADMIN.
    # Returns configured location.
    locationConfigure(
        # ID of location to configure.
        locationID: ID!
        # Batch input for location configuration.
        config: BatchLocationInput!
    ): Location!
    # Set a common parent for locations. Parent can either be a region or a location.
    # Authorization: must be at least ADMIN.
    locationSetParents(
        # IDs of (children) locations (which we set a parent for).
        locationIDs: [ID!]!
        # ID of parent location/region.
        parentID: ID!
    ): Void
    # Delete locations.
    # Authorization: must be at least ADMIN.
    locationDelete(
        # IDs of locations to delete.
        locationIDs: [ID!]!
    ): Void
    # Create new server.
    # Authorization: must be at least ADMIN.
    # Returns created server.
    serverCreate(
        # Batch input for server creation.
        config: BatchServerInput!
    ): Server!
    # Batch configuration of a server.
    # Authorization: must be at least ADMIN.
    # Returns configured server.
    serverConfigure(
        # ID of server to configure.
        serverID: ID!
        # Selected mode to apply this configuration to an ECDN server.
        mode: ConfigurationMode!
        # Batch input for server configuration.
        config: BatchServerInput!
    ): Server!
    # Enable content delivery on servers.
    # Authorization: must be at least ADMIN.
    serverEnableContentDelivery(
        # IDs of servers to enable content delivery on.
        serverIDs: [ID!]!
    ): Void
    # Disable content delivery on servers.
    # Authorization: must be at least ADMIN.
    serverDisableContentDelivery(
        # IDs of servers to disable content delivery on.
        serverIDs: [ID!]!
    ): Void
    # Enable remote assistance on servers.
    # Authorization: must be at least ADMIN.
    serverEnableRemoteAssistance(
        # IDs of servers to enable remote assistance on.
        serverIDs: [ID!]!
    ): Void
    # Disable remote assistance on servers.
    # Authorization: must be at least ADMIN.
    serverDisableRemoteAssistance(
        # IDs of servers to disable remote assistance on.
        serverIDs: [ID!]!
    ): Void
    # Delete servers.
    # Authorization: must be at least ADMIN.
    serverDelete(
        # IDs of servers to delete.
        serverIDs: [ID!]!
    ): Void
    # Create time-series report of ECDN video delivery.
    # Interval of a query with minutely granularity cannot exceed 24 hours.
    # Metrics older than 1 year are discarded.
    # Returns created report.
    reportCreate(
        # Granularity of time intervals.
        granularity: Granularity!
        # Break down report's intervals by additional fields.
        breakdown: ReportBreakdown
        # Start report from this point in time.
        from: Time!
        # End report at this point in time.
        to: Time!
        # Send created report to this email address.
        email: EmailAddress!
        # Included fields in the report.
        include: [ReportField!]!
    ): Report!
}

Fields

locationCreate: Location!

Create new location. Authorization: must be at least ADMIN. Returns created location.

ARGUMENTTYPENULLABLELISTDESCRIPTION
configBatchLocationInputYESNOBatch input for location creation.

locationConfigure: Location!

Batch configuration of a location. Authorization: must be at least ADMIN. Returns configured location.

ARGUMENTTYPENULLABLELISTDESCRIPTION
locationIDIDYESNOID of location to configure.
configBatchLocationInputYESNOBatch input for location configuration.

locationSetParents: Void

Set a common parent for locations. Parent can either be a region or a location. Authorization: must be at least ADMIN.

ARGUMENTTYPENULLABLELISTDESCRIPTION
locationIDsIDYESYESIDs of (children) locations (which we set a parent for).
parentIDIDYESNOID of parent location/region.

locationDelete: Void

Delete locations. Authorization: must be at least ADMIN.

ARGUMENTTYPENULLABLELISTDESCRIPTION
locationIDsIDYESYESIDs of locations to delete.

serverCreate: Server!

Create new server. Authorization: must be at least ADMIN. Returns created server.

ARGUMENTTYPENULLABLELISTDESCRIPTION
configBatchServerInputYESNOBatch input for server creation.

serverConfigure: Server!

Batch configuration of a server. Authorization: must be at least ADMIN. Returns configured server.

ARGUMENTTYPENULLABLELISTDESCRIPTION
serverIDIDYESNOID of server to configure.
modeConfigurationModeYESNOSelected mode to apply this configuration to an ECDN server.
configBatchServerInputYESNOBatch input for server configuration.

serverEnableContentDelivery: Void

Enable content delivery on servers. Authorization: must be at least ADMIN.

ARGUMENTTYPENULLABLELISTDESCRIPTION
serverIDsIDYESYESIDs of servers to enable content delivery on.

serverDisableContentDelivery: Void

Disable content delivery on servers. Authorization: must be at least ADMIN.

ARGUMENTTYPENULLABLELISTDESCRIPTION
serverIDsIDYESYESIDs of servers to disable content delivery on.

serverEnableRemoteAssistance: Void

Enable remote assistance on servers. Authorization: must be at least ADMIN.

ARGUMENTTYPENULLABLELISTDESCRIPTION
serverIDsIDYESYESIDs of servers to enable remote assistance on.

serverDisableRemoteAssistance: Void

Disable remote assistance on servers. Authorization: must be at least ADMIN.

ARGUMENTTYPENULLABLELISTDESCRIPTION
serverIDsIDYESYESIDs of servers to disable remote assistance on.

serverDelete: Void

Delete servers. Authorization: must be at least ADMIN.

ARGUMENTTYPENULLABLELISTDESCRIPTION
serverIDsIDYESYESIDs of servers to delete.

reportCreate: Report!

Create time-series report of ECDN video delivery. Interval of a query with minutely granularity cannot exceed 24 hours. Metrics older than 1 year are discarded. Returns created report.

ARGUMENTTYPENULLABLELISTDESCRIPTION
granularityGranularityYESNOGranularity of time intervals.
breakdownReportBreakdownNONOBreak down report’s intervals by additional fields.
fromTimeYESNOStart report from this point in time.
toTimeYESNOEnd report at this point in time.
emailEmailAddressYESNOSend created report to this email address.
includeReportFieldYESYESIncluded fields in the report.