Search
K
Petstore API

Swagger Petstore - OpenAPI 3.0

1.0.27OAS 3.0

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about
Swagger at https://swagger.io. In the third iteration of the pet store, we’ve switched to the design first approach!
You can now help us improve the API whether it’s by making changes to the definition itself or to the code.
That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

API Base URL
  • Server 1:/api/v3
Security
petstore_auth (oauth2)

Implicit OAuth Flow

Authorize URL: https://petstore3.swagger.io/oauth/authorize

Scopes:

  • write:pets - modify pets in your account
  • read:pets - read your pets
api_key (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called api_key.

Example: api_key: 123

Additional Information
Contact (apiteam@swagger.io)
Apache 2.0 License Find out more about Swagger

pet

Everything about your Pets

Update an existing pet.

Update an existing pet by Id.

put
/api/v3/pet

Body

Update an existent pet in the store

Pet

idinteger(int64)

Example:10

namestringrequired

Example:doggie

categoryobject
Show Child Parameters
photoUrlsarray[string]required
tagsarray[object]
Show Child Parameters
statusstring

pet status in the store

Allowed values:availablependingsold

Response

Successful operation

Pet

idinteger(int64)

Example:10

namestringrequired

Example:doggie

categoryobject
Show Child Parameters
photoUrlsarray[string]required
tagsarray[object]
Show Child Parameters
statusstring

pet status in the store

Allowed values:availablependingsold

put/pet

Body

{ "name": "doggie", "photoUrls": [ "[]" ] }
 
Invalid URL value '/api/v3/pet'
- missing protocol