Pets API Functions

With these API functions, you can manage the pets in your store's database.

Adding a new pet

Adds a new pet to the store's database.

Endpoint: https://petstore3.swagger.io/api/v3/pet

Operation: POST

Examples

API Key
OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d '{
  "id": 0,
  "name": "string",
  "category": {
    "id": 0,
    "name": "string"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}'

POST "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-d '{
  "id": 0,
  "name": "string",
  "category": {
    "id": 0,
    "name": "string"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}'

Responses

Code	Description
200	Successful operation
400	Invalid input
404	Pet not found
422	Validation exception
default	Unexpected error

Response example

200: Successful operation

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parameters

Request body

Name	Type	Description
body	Pet object	(Required) The `Pet` object to add to the store.

Updating an existing pet

Updates an existing pet by its ID.

Endpoint: https://petstore3.swagger.io/api/v3/pet

Operation: PUT

Examples

API Key
OAuth 2.0

PUT "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d '{
    "id": 210,
    "name": "Krypto",
    "status": "available"
  }'

PUT "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-d '{
    "id": 210,
    "name": "Krypto",
    "status": "available"
  }'

Responses

Code	Description
200	Successful operation
400	Invalid input
404	Pet not found
422	Validation exception
default	Unexpected error

Response example

200: Successful operation

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parameters

Request body

Name	Type	Description
body	Pet object	(Required) Pet object to update.

Finding a pet by status

Finds pets by their status.

Endpoint: https://petstore3.swagger.io/api/v3/pet/findByStatus

Operation: GET

Examples

API Key
OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

GET "https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

Responses

Code	Description
200	Successful operation
400	Invalid input
default	Unexpected error

Response example

200: Successful operation

[
  {
    "id": 210,
    "name": "Krypto",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }
]

Parameters

Query parameters

Name	Type	Description
status	string	Status of the pet to find. Default: `available`. Allowed values: `available`, `pending`, `sold`.

Finding pets by tags

Finds pets by their tags.

Endpoint: https://petstore3.swagger.io/api/v3/pet/findByTags

Operation: GET

Examples

API Key
OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/findByTags?tags=string" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

GET "https://petstore3.swagger.io/api/v3/pet/findByTags?tags=string" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

Responses

Code	Description
200	Successful operation
400	Invalid input
default	Unexpected error

Response example

200: Successful operation

[
  {
    "id": 210,
    "name": "Krypto",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }
]

Parameters

Query parameters

Name	Type	Description
tags	array	Tags to filter by. Default: `[]`. Allowed values: Any valid tag names.

Finding a pet by Id

Finds a pet by its unique ID.

Endpoint: https://petstore3.swagger.io/api/v3/pet/{petId}

Operation: GET

Examples

API Key
OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

GET "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

Responses

Code	Description
200	Successful operation
400	Invalid ID supplied
404	Pet not found
default	Unexpected error

Response example

200: Successful operation

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parameters

Path p1arameters

Name	Type	Description
petId	integer	ID of pet to return

Updating a pet with form data

Updates a pet in the store with form data.

Endpoint: https://petstore3.swagger.io/api/v3/pet/{petId}

Operation: POST

Examples

API Key
OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet/210" \
-H "api_key: <YOUR_API_KEY>" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "name=Krypto" \
--data-urlencode "status=available"

POST "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "name=Krypto" \
--data-urlencode "status=available"

Responses

Code	Description
200	Successful operation
405	Invalid input
default	Unexpected error

Response example

200: Successful operation

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parameters

Path parameters

Name	Type	Description
petId	integer	ID of pet to update

Query parameters

Name	Type	Description
name	string	Name of pet to update
status	string	Status of pet to update

Deleting a pet

Deletes a pet from the database.

Endpoint: https://petstore3.swagger.io/api/v3/pet/{petId}

Operation: DELETE

Examples

API Key
OAuth 2.0

DELETE "https://petstore3.swagger.io/api/v3/pet/210" \
-H "api_key: <YOUR_API_KEY>"

DELETE "https://petstore3.swagger.io/api/v3/pet/210" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

Responses

Code	Description
200	Pet deleted
400	Invalid ID supplied
404	Pet not found

(A successful deletion returns a 200 code with no response body.)

Parameters

Path parameters

Name	Type	Description
petId	integer	ID of pet to delete

Uploading an image

Uploads an image for a pet.

Endpoint: https://petstore3.swagger.io/api/v3/pet/{petId}/uploadImage

Operation: POST

Examples

API Key
OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet/210/uploadImage" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "api_key: <YOUR_API_KEY>" \
--form "file=@/path/to/your/file"

POST "https://petstore3.swagger.io/api/v3/pet/210/uploadImage" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
--form "file=@/path/to/your/file"

Responses

Code	Description
200	Successful operation
default	Unexpected error

Response examples

200: Successful operation

{
  "code": 200,
  "type": "unknown",
  "message": "additional data"
}

Parameters

Path parameters

Name	Type	Description
petId	integer	ID of pet to update

Form data parameters

Name	Type	Description
additionalMetadata	string	Extra data to pass to server.
file	file	File to upload.

Adding a new pet​

Examples​

Responses​

Response example​

Parameters​

Request body​

Updating an existing pet​

Examples​

Responses​

Response example​

Parameters​

Request body​

Finding a pet by status​

Examples​

Responses​

Response example​

Parameters​

Query parameters​

Finding pets by tags​

Examples​

Responses​

Response example​

Parameters​

Query parameters​

Finding a pet by Id​

Examples​

Responses​

Response example​

Parameters​

Path p1arameters​

Updating a pet with form data​

Examples​

Responses​

Response example​

Parameters​

Path parameters​

Query parameters​

Deleting a pet​

Examples​

Responses​

Parameters​

Path parameters​

Uploading an image​

Examples​

Responses​

Response examples​

Parameters​

Path parameters​

Form data parameters​

Adding a new pet

Examples

Responses

Response example

Parameters

Request body

Updating an existing pet

Examples

Responses

Response example

Parameters

Request body

Finding a pet by status

Examples

Responses

Response example

Parameters

Query parameters

Finding pets by tags

Examples

Responses

Response example

Parameters

Query parameters

Finding a pet by Id

Examples

Responses

Response example

Parameters

Path p1arameters

Updating a pet with form data

Examples

Responses

Response example

Parameters

Path parameters

Query parameters

Deleting a pet

Examples

Responses

Parameters

Path parameters

Uploading an image

Examples

Responses

Response examples

Parameters

Path parameters

Form data parameters