JSON API » outgroups » outgroups/delete

Deletes an outbound group.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of outbound group to delete.Yes

Responses

CodeDescription
204Success.
400One or more routes use this outbound group.
401The authentication details provided are invalid.
402Your role does not allow this.
404The outbound group does not exist.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/outgroups/delete/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.