Follow

Delete Article

 

The Delete Article command allows you to remove an Article in your realm.  

Arguments

The Delete Article command requires the following arguments: Command, Realm,  Password and Article Name.

api_web?r=myrealm&p=mypass&c=deletearticle&article_name=myarticle

The command is ‘deletearticle’, the realm is ‘myrealm’ and the password is ‘mypass’. The article named 'myarticle' will be deleted.

The Delete Article command supports the following arguments:

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=deletearticle

c=deletearticle

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm= [realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

Article Name

Yes

Name of the article to delete. To include spaces, use + or %20 to avoid possible issues with spaces in a URL.

article_name=[article_name]

 

Example

Using all commands and arguments (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=deletearticle&article_name=myarticle

Successful results return:

SUCCESS

Results

The Delete Article command outputs either a SUCCESS or a FAILURE message. 

SUCCESS

The Delete Article command returns a simple SUCCESS message if the article was deleted with no errors. 

FAILURE

A Delete Article command will fail for several reasons, such as if the article does not exist.  The result format is:

FAILURE: [Reason]  

 
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk