Cloudflare Docs
Style Guide
Style Guide
Edit this page
Report an issue with this page
Log into the Cloudflare dashboard
Set theme to dark (⇧+D)

Method types & common verbs

The verb examples are a small handful of commonly used verbs associated with a method, but you should not feel limited and only use the verbs in the examples.

When writing the endpoint title, use the root form of the verb. For example, “Create a namespace.”

For the endpoint description, use the present tense of the verb. For example, “Creates a namespace under the given title.”

Additionally, using the method type as the verb in the title and description is okay. For example, using the method GET and including it in the description as “Gets embed code” is acceptable.

MethodPurposeVerb examples
GETRetrieves a resourceGets, Lists, Returns, Downloads
POSTCreates a resourceCreates, Watches, Inserts, Adds
PUTUpdates or creates an existing resourceUpdates, Modifies, Adds
PATCHPartially modifies an existing resourceUpdates, Edits, Changes
DELETERemoves the resourceDeletes, Removes, Cancels