SEsecurityscorecard
portfolios

Edit a portfolio

Changed on
put/portfolios/{portfolio_id}

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/portfolios/{portfolio_id}
  • Auth
    API key in header Authorization

Path parameters

portfolio_idstring uuid required

Unique identifier for the resource

Request body

namestring required

human-readable name

descriptionstring

human-readable description

privacy'private' | 'shared' | 'team'

private: only visible to owner, shared: visible to the entire organization, team: group of users within an organization

Example request

{
  "name": "Our Vendors",
  "description": "These are all the vendors we monitor for security risk",
  "privacy": "private"
}

Response

the edited portfolio

idstring

Identifier

namestring

human-readable name

descriptionstring

human-readable description

privacy'private' | 'shared' | 'team'

private: only visible to owner, shared: visible to the entire organization, team: group of users within an organization

tag_typestring

Example response

{
  "id": "aea7dae2-370f-4279-a458-4c7cb9661778",
  "name": "Our Vendors",
  "description": "These are all the vendors we monitor for security risk",
  "privacy": "private"
}

Changes

  • b465b4846039Revision changes
    • breaking

      added the pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ to the path request parameter portfolio_id

    • breaking

      for the path request parameter portfolio_id, the format changed from no format to uuid

    • breaking

      the response property became optional for the status

    • info

      media type application/json; charset=utf-8 was changed to application/json for the response status

    • info

      added the optional property to the response with the status

    • info

      the response's property pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ was added for the status