What restful api method would be appropriate for an upsert ?

Create/Update endpoint in a restful api

The PUT API methodology should be appropriate for an upsert

According to the HTTP specification:

The PUT method requests that the enclosed entity be stored under the supplied Request-URI. If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a modified version of the one residing on the origin server. If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new resource by the requesting user agent, the origin server can create the resource with that URI.

I therefore think that the use of PUT for an insert or update is perfectly legitimate, provided that in both cases the URI is known in advance. If you’re using the key as part of the URI (as k1 in this should be the case. To be ideally RESTful, however, a GET to the same URL should also allow you to download the resource.

Leave a Reply