Commands

Creating a new pet

Create pet.

POST https://api.myapi.com/v1/pet

Creates a new pet.

Request Body

Name	Type	Description
name*	string	The name of the pet
owner_id	string	The id of the user who owns the pet
species	string	The species of the pet
breed	string	The breed of the pet

200 Pet successfully created

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

401 Permission denied

Good to know: This API method was created using the API Method block, it's how you can build out an API method documentation from scratch. Have a play with the block and you'll see you can do some nifty things like add and reorder parameters, document responses, and give your methods detailed descriptions.

Updating a pet

Update an existing pet

put

https://petstore.swagger.io/v2http://petstore.swagger.io/v2

/pet

Required scopes

This endpoint requires the following scopes:

• : read your pets
• : modify pets in your account

Authorizations

petstore_auth

OAuth2implicitRequired

Authorization URL:

Body

application/jsonapplication/xml

idinteger · int64Optional

namestringRequiredExample: doggie

photoUrlsstring[]Required

statusstring · enumOptional

pet status in the store

Possible values:

Responses

400

Invalid ID supplied

404

Pet not found

405

Validation exception

put

/pet

HTTPcURLJavaScriptPython

PUT /v2/pet HTTP/1.1
Host: petstore.swagger.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "id": 1,
  "category": {
    "id": 1,
    "name": "text"
  },
  "name": "doggie",
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

application/jsonapplication/xml

No content

Good to know: This API method was auto-generated from an example Swagger file. You'll see that it's not editable – that's because the contents are synced to a URL! Any time the linked file changes, the documentation will change too.