Class AddHttpEndpoint

Register a new HTTP endpoint via DuetWebServer. This will create a new HTTP endpoint under /machine/{Namespace}/{EndpointPath}. Returns a path to the UNIX socket which DuetWebServer will connect to whenever a matching HTTP request is received. A plugin using this command has to open a new UNIX socket with the given path that DuetWebServer can connect to

Inheritance

object

BaseCommand

Command<string>

AddHttpEndpoint

AddHttpEndpoint

Inherited Members

Command<string>.Execute()

Command<string>.Invoke()

BaseCommand.Command

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetAPI.Commands

Assembly: DuetAPI.dll

Syntax

[RequiredPermissions(SbcPermissions.RegisterHttpEndpoints)]
public class AddHttpEndpoint : Command<string>

Properties

EndpointType

Type of the HTTP request

Declaration

public HttpEndpointType EndpointType { get; set; }

Property Value

Type	Description
HttpEndpointType

IsUploadRequest

Whether this is an upload request

Declaration

public bool IsUploadRequest { get; set; }

Property Value

Type	Description
bool

See Also

IsUploadRequest

Namespace

Namespace of the plugin wanting to create a new third-party endpoint

Declaration

public string Namespace { get; set; }

Property Value

Type	Description
string

Path

Path to the endpoint to register

Declaration

public string Path { get; set; }

Property Value

Type	Description
string

See Also

ReceivedHttpRequest

SendHttpResponse